查询镜像列表（openstack原生v2-九游平台

功能介绍

获取镜像列表。

使用本接口查询镜像列表时，需要使用分页查询才能返回全部的镜像列表。

当前接口已废弃，推荐使用。

分页说明

分页是指返回一组镜像的一个子集，在返回的时候会存在下个子集的链接和首个子集的链接，默认返回的子集中数量为25，用户也可以通过使用limit和marker两个参数自己分页，指定返回子集中需要返回的数量。

响应中的参数first是查询九游平台首页的url。next是查询下一页的url。当查询镜像列表最后一页时，不存在next。

调试

您可以在中调试该接口。

uri

get /v2/images

常用列表查询方法

• 公共镜像列表查询

  get /v2/images?__imagetype=gold&visibility=public&protected=true

• 私有镜像列表查询

  get /v2/images?owner={project_id}

• 可以使用的共享镜像列表

  get /v2/images?member_status=accepted&visibility=shared&__imagetype=shared

• 被拒绝的共享镜像列表

  get /v2/images?member_status=rejected&visibility=shared&__imagetype=shared

• 未接受的共享镜像列表

  get /v2/images?member_status=pending&visibility=shared&__imagetype=shared

请求消息

请求参数

无

请求示例

查询镜像列表。

get https://{endpoint}/v2/images

响应消息

• 响应参数

  参数	参数类型	描述
  first	string	查询九游平台首页的url。
  next	string	查询下一页的url。当查询镜像列表最后一页时，不存在next。
  schema	string	描述镜像列表模式的url。
  images	array of objects	资源类型。 具体请参见表2。

  表2 images字段说明

  参数	参数类型	描述
  __backup_id	string	备份id。如果是备份创建的镜像，则填写为备份的id，否则无此参数。
  __data_origin	string	镜像来源。公共镜像为空。
  __description	string	镜像描述信息。
  __image_location	string	镜像的存储位置。
  __image_size	string	镜像文件的大小，单位为字节。目前取值为大于0的字符串。
  __image_source_type	string	镜像后端存储类型，目前只支持uds。
  __is_config_init	string	是否完成了初始化配置。取值为“true”或“false”。
  __isregistered	string	镜像是否可用，取值为true，扩展接口会默认为true，普通用户只能查询取值为true的镜像。
  __lazyloading	string	镜像是否支持延迟加载。取值为true、false、true或false。
  __originalimagename	string	父镜像id。公共镜像或通过文件创建的私有镜像，取值为空。
  __imagetype	string	镜像类型，目前支持以下类型： 公共镜像：gold 私有镜像：private 共享镜像：shared 市场镜像：market
  protected	boolean	镜像是否是受保护，查询公共镜像时候取值为true，查询私有镜像可以不指定。
  virtual_env_type	string	镜像使用的环境类型：fusioncompute、ironic、dataimage、isoimage。 如果是云服务器镜像（即系统盘镜像），则取值为fusioncompute。 如果是数据盘镜像，则取值是dataimage。 如果是裸金属服务器镜像，则取值是ironic。 如果是iso镜像，则取值是isoimage。
  virtual_size	integer	目前暂时不使用。
  visibility	string	是否被其他租户可见。取值如下： public：表示公共镜像。 private：表示私有镜像。 shared：表示共享镜像。
  owner	string	镜像属于哪个租户。
  id	string	镜像id。
  status	string	镜像状态。取值如下： queued：表示镜像元数据已经创建成功，等待上传镜像文件。 saving：表示镜像正在上传文件到后端存储。 deleted：表示镜像已经删除。 killed：表示镜像上传错误。 active：表示镜像可以正常使用。
  name	string	镜像名称。name参数说明请参考。
  container_format	string	容器类型。
  disk_format	string	镜像格式，目前支持zvhd2、vhd、zvhd、raw、qcow2、iso。非iso格式时默认值是zvhd2。
  min_ram	integer	镜像运行需要的最小内存，单位为mb。参数取值依据云服务器的规格限制，一般为0。 云服务器的规格限制，请参见规格清单。
  max_ram	string	镜像支持的最大内存，单位为mb。
  min_disk	integer	镜像运行需要的最小磁盘容量，单位为gb 。linux操作系统取值为10～1024gb，windows操作系统取值为20～1024gb。
  __os_bit	string	操作系统位数，一般取值为32或者64。
  __os_feature_list	string	镜像附加属性。该属性采用json格式来标识镜像支持的高级特性清单。
  __platform	string	镜像平台分类，取值为windows、ubuntu、red hat、suse、centos、debian、opensuse、oracle linux、fedora、other、coreos和euleros。
  schema	string	镜像视图。
  self	string	镜像链接信息。
  size	integer	目前暂时不使用。
  __os_type	string	镜像系统类型，取值为linux、windows、other。
  __os_version	string	操作系统具体版本。
  tags	array of strings	镜像标签列表，提供用户可以自定义管理私有镜像的能力。
  __support_kvm	string	如果镜像支持kvm，取值为true，否则无此属性。
  __support_xen	string	如果镜像支持xen，取值为true，否则无此属性。
  __support_largememory	string	表示该镜像支持超大内存。如果镜像支持超大内存，取值为true，否则无此属性。
  __support_diskintensive	string	表示该镜像支持密集存储。如果镜像支持密集存储性能，则值为true，否则无此属性。
  __support_highperformance	string	表示该镜像支持高计算性能。如果镜像支持高计算性能，则值为true，否则无此属性。
  __support_xen_gpu_type	string	表示该镜像是支持xen虚拟化平台下的gpu类型。支持gpu加速型实例的镜像操作系统类型请参考。如果不支持xen虚拟化下gpu类型，无此属性。该属性与“__support_xen”和“__support_kvm”属性不共存。
  __support_kvm_gpu_type	string	表示该镜像是支持kvm虚拟化平台下的gpu类型，取值参考。如果不支持kvm虚拟化下gpu类型，无此属性。该属性与“__support_xen”和“__support_kvm”属性不共存。
  __support_xen_hana	string	如果镜像支持xen虚拟化下hana类型，取值为true。否则，无此属性。 该属性与“__support_xen”和“__support_kvm”属性不共存。
  __support_kvm_infiniband	string	如果镜像支持kvm虚拟化下infiniband网卡类型，取值为true。否则，无此属性。 该属性与“__support_xen”属性不共存。
  __productcode	string	市场镜像的产品id。
  __root_origin	string	表示当前镜像来源是从外部导入。取值样例：file。
  __sequence_num	string	表示当前镜像对应云服务器的系统盘插槽位置。 取值样例：0。
  __support_fc_inject	string	表示当前镜像支持cloud-init密码/密钥注入方式。 如果取值为“true”，表示该镜像不支持cloud-init注入密码/密钥，其他取值时表示支持cloud-init注入密钥/密码。 说明： 该特性参数只对ecs系统盘镜像生效，其他类型镜像不生效。
  __is_offshelved	string	表示当前市场镜像是否下架。 true：已下架 false：未下架
  created_at	string	创建时间。格式为utc时间。
  updated_at	string	更新时间。格式为utc时间。
  active_at	string	镜像状态变为正常的时间。
  checksum	string	目前暂时不使用。
  hw_firmware_type	string	云服务器的启动方式。目前支持： bios：表示bios引导启动。 uefi：表示uefi引导启动。
  file	string	镜像文件下载和上传链接。
  enterprise_project_id	string	表示当前镜像所属的企业项目。 取值为0或无该值，表示属于default企业项目。 取值为uuid，表示属于该uuid对应的企业项目。
  _sys_enterprise_project_id	string	表示当前镜像所属的企业项目。 取值为0或无该值，表示属于default企业项目。 取值为uuid，表示属于该uuid对应的企业项目。
  __support_arm	string	是否是arm架构类型的镜像。取值为“true”或者“false”。
  __support_agent_list	string	镜像是否支持主机安全或主机监控。 hss：主机安全 ces：主机监控 取值样例： "__support_agent_list": "hss,ces" 说明： 如果查询结果无此字段，表示镜像不支持主机安全或主机监控。
  __account_code	string	收费镜像标识。
  __support_amd	string	是否是amd架构类型的镜像。取值为“true”或者“false”。
  __system__cmkid	string	加密镜像所使用的密钥id。
  hw_vif_multiqueue_enabled	string	镜像是否支持网卡多队列。取值为“true”或者“false”。

• 响应样例

  status code 200

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69

  { "schema":"/v2/schemas/images", "next":"/v2/images?__isregistered=true&marker=0328c25e-c840-4496-81ac-c4e01b214b1f&__imagetype=gold&limit=2", "images":[ { "schema":"/v2/schemas/image", "min_disk":100, "created_at":"2018-09-06t14:03:27z", "__image_source_type":"uds", "container_format":"bare", "file":"/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52/file", "updated_at":"2018-09-06t15:17:33z", "protected":true, "checksum":"d41d8cd98f00b204e9800998ecf8427e", "id":"bc6bed6e-ba3a-4447-afcc-449174a3eb52", "__isregistered":"true", "min_ram":2048, "__lazyloading":"true", "owner":"1bed856811654c1cb661a6ca845ebc77", "__os_type":"linux", "__imagetype":"gold", "visibility":"public", "virtual_env_type":"fusioncompute", "tags":[], "__platform":"centos", "size":0, "__os_bit":"64", "__os_version":"centos 7.3 64bit", "name":"centos 7.3 64bit vivado", "self":"/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52", "disk_format":"zvhd2", "virtual_size":null, "hw_firmware_type":"bios", "status":"active" }, { "schema":"/v2/schemas/image", "min_disk":100, "created_at":"2018-09-06t14:03:05z", "__image_source_type":"uds", "container_format":"bare", "file":"/v2/images/0328c25e-c840-4496-81ac-c4e01b214b1f/file", "updated_at":"2018-09-25t14:27:40z", "protected":true, "checksum":"d41d8cd98f00b204e9800998ecf8427e", "id":"0328c25e-c840-4496-81ac-c4e01b214b1f", "__isregistered":"true", "min_ram":2048, "__lazyloading":"true", "owner":"1bed856811654c1cb661a6ca845ebc77", "__os_type":"linux", "__imagetype":"gold", "visibility":"public", "virtual_env_type":"fusioncompute", "tags":[], "__platform":"centos", "size":0, "__os_bit":"64", "__os_version":"centos 7.3 64bit", "name":"centos 7.3 64bit with sdx", "self":"/v2/images/0328c25e-c840-4496-81ac-c4e01b214b1f", "disk_format":"zvhd2", "virtual_size":null, "hw_firmware_type":"bios", "status":"active" } ], "first":"/v2/images?__isregistered=true&__imagetype=gold&limit=2" }

返回值

• 正常

  200

• 异常

  返回值	说明
  400 bad request	请求错误，具体返回错误码请参考。
  401 unauthorized	鉴权失败。
  403 forbidden	没有操作权限。
  404 not found	找不到资源。
  500 internal server error	服务内部错误。
  503 service unavailable	服务不可用。