查询中心镜像列表 - ListCloudImages

功能介绍

查询租户在某个云Region的可见镜像列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1/cloudimages/{region_id}

表1 路径参数
参数	是否必选	参数类型	描述
region_id	是	String	华为云区域ID

表2 Query参数
参数	是否必选	参数类型	描述
__imagetype	否	String	镜像类型，目前支持以下类型：公共镜像：gold 私有镜像：private
__isregistered	否	String	镜像是否可用，取值为true/false。说明：查询公共镜像时，该参数无效。
__os_type	否	String	镜像系统类型，取值如下： Linux Windows Other
__support_diskintensive	否	String	表示该镜像支持密集存储。如果镜像支持密集存储性能，则值为true，否则无需增加该属性。
__support_highperformance	否	String	表示该镜像支持高计算性能。如果镜像支持高计算性能，则值为true，否则无需增加该属性。
__support_kvm	否	String	如果镜像支持KVM，取值为true，否则无该属性。
__support_kvm_gpu_type	否	String	如果镜像是支持KVM虚拟化平台下的GPU类型，取值为“V100_vGPU”或者“RTX5000”，否则无该属性。
__support_kvm_infiniband	否	String	如果镜像支持KVM虚拟化下Infiniband网卡类型，取值为true。否则，无需添加该属性。该属性与“__support_xen”属性不共存。
__support_largememory	否	String	表示该镜像支持超大内存。如果镜像支持超大内存，取值为true，否则无需增加该属性。
__support_xen	否	String	如果镜像支持XEN，取值为true，否则无需增加该属性。
__support_xen_gpu_type	否	String	表示该镜像是支持XEN虚拟化平台下的GPU优化类型，取值为：“M60_vGPU”。如果不支持XEN虚拟化下GPU类型，无需添加该属性。该属性与“__support_xen”和“__support_kvm”属性不共存。
__support_xen_hana	否	String	如果镜像支持XEN虚拟化下HANA类型，取值为true。否则，无需添加该属性。该属性与“__support_xen”和“__support_kvm”属性不共存。
id	否	String	镜像ID，精确匹配。
limit	否	Integer	用于分页，表示查询几条镜像记录，取值为正整数，最大（默认）取值为500
marker	否	String	用于分页，表示从哪个镜像开始查询，取值为镜像ID。
name	否	String	镜像名称，匹配规则为精确匹配。
owner	否	String	镜像属于哪个租户。
protected	否	String	镜像是否是受保护，取值为true/false，一般查询公共镜像时候取值为true，查询私有镜像可以不指定。
sort_dir	否	String	用于排序，表示升序还是降序，取值为asc和desc，与sort_key一起组合使用，默认为降序desc。
sort_key	否	String	用于排序，表示按照哪个字段排序，取值为镜像属性name、status、disk_format、created_at，默认取值为created_at。
status	否	String	镜像状态。取值如下： saving：表示镜像正在上传文件到后端存储 deleted：表示镜像已经删除 killed：表示镜像上传错误 active：表示镜像可以正常使用
virtual_env_type	否	String	镜像使用环境类型。目前仅支持系统盘镜像，取值为：FusionCompute
visibility	否	String	是否被其他租户可见，取值如下： public：公共镜像 private：私有镜像

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
images	Array of ImageInfo objects	查询返回的镜像列表。

表5 ImageInfo
参数	参数类型	描述
__backup_id	String	备份ID。如果是备份创建的镜像，则填写为备份的ID，否则为空
__data_origin	String	镜像来源。公共镜像为空
__description	String	镜像描述信息。支持字母、数字、中文等，不支持回车、<、 >，长度不能超过1024个字符。
__image_size	String	镜像文件的大小，单位为字节
__image_source_type	String	镜像后端存储类型，目前只支持uds
__imagetype	String	镜像类型，目前支持以下类型：公共镜像：gold 私有镜像：private 共享镜像：shared 市场镜像:market
__isregistered	String	是否是注册过的镜像，取值为“true”或者“false”
__originalimagename	String	父镜像ID。公共镜像或通过文件创建的私有镜像，取值为空
__os_bit	String	操作系统位数，一般取值为“32”或者“64”
__os_type	String	操作系统类型，目前取值Linux， Windows，Other
__os_version	String	操作系统具体版本
__platform	String	镜像平台分类
__productcode	String	市场镜像的产品ID
__support_diskintensive	String	镜像来源表示该镜像支持密集存储。如果镜像支持密集存储性能，则值为true，否则无需增加该属性。
__support_highperformance	String	表示该镜像支持高计算性能。如果镜像支持高计算性能，则值为true，否则无需增加该属性。
__support_kvm	String	如果镜像支持KVM，取值为true，否则无需增加该属性。
__support_kvm_gpu_type	String	表示该镜像是支持KVM虚拟化平台下的GPU类型，如果不支持KVM虚拟机下GPU类型，无需添加该属性。该属性与“__support_xen”和“__support_kvm”属性不共存。
__support_kvm_infiniband	String	如果镜像支持KVM虚拟化下Infiniband网卡类型，取值为true。否则，无需添加该属性。该属性与“__support_xen”属性不共存。
__support_largememory	String	表示该镜像支持超大内存。如果镜像支持超大内存，取值为true，否则无需增加该属性。
__support_xen	String	如果镜像支持XEN，取值为true，否则无需增加该属性。
__support_xen_gpu_type	String	表示该镜像是支持XEN虚拟化平台下的GPU优化类型，取值为：“M60_vGPU”。如果不支持XEN虚拟化下GPU类型，无需添加该属性。该属性与“__support_xen”和“__support_kvm”属性不共存。
__support_xen_hana	String	如果镜像支持XEN虚拟化下HANA类型，取值为true。否则，无需添加该属性。该属性与“__support_xen” 和“__support_kvm”属性不共存。
checksum	String	目前暂时不使用
container_format	String	容器类型
created_at	String	创建时间。格式为UTC时间
disk_format	String	镜像的格式，目前支持vhd，zvhd、raw，qcow2。默认值是vhd
enterprise_project_id	String	表示当前镜像所属的企业项目。取值为0或无该值，表示属于default企业项目，取值为UUID，表示属于该UUID对应的企业项目。
file	String	镜像文件下载和上传链接
id	String	镜像ID
min_disk	Integer	镜像运行需要的最小磁盘容量，单位为GB。取值为40～1024GB。
min_ram	Integer	镜像运行需要的最小内存，单位为MB。参数取值依据弹性云服务器的规格限制，默认设置为0
name	String	镜像名称。名称的首尾字母不能为空格。名称的长度至为1～128位。名称包含以下4种字符：大写字母小写字母数字特殊字符包含-、.、_、空格和中文。
owner	String	镜像属于哪个租户
protected	Boolean	是否是受保护的，受保护的镜像不允许删除。取值为true或false
schema	String	镜像视图
self	String	镜像链接信息
size	Integer	目前暂时不使用
status	String	镜像状态。取值如下：queued：表示镜像元数据已经创建成功，等待上传镜像文件。saving：表示镜像正在上传文件到后端存储。deleted：表示镜像已经删除。killed：表示镜像上传错误。active：表示镜像可以正常使用
tags	Array of strings	镜像标签列表
updated_at	String	更新时间。格式为UTC时间
virtual_env_type	String	镜像使用环境类型：FusionCompute，Ironic，DataImage。如果弹性云服务器镜像，则取值为FusionCompute，如果是数据卷镜像则取Dat aImage，如果是裸金属服务器镜像，则取值是Ironic
virtual_size	Integer	目前暂时不使用
visibility	String	是否被其他租户可见，取值为private或public
hw_firmware_type	String	云服务器的启动方式。目前支持： bios：表示bios引导启动。 uefi：表示uefi引导启动。
__support_arm	String	是否是ARM架构类型的镜像，取值为“true”或者“false”。
max_ram	String	镜像支持的最大内存，单位为MB。取值可以参考云服务器规格限制，一般不设置。
hw_vif_multiqueue_enabled	String	镜像是否支持网卡多队列。取值为“true”或者“false”。
__root_origin	String	表示当前镜像来源是从外部导入。取值：file。
__sequence_num	String	表示当前镜像对应云服务器的系统盘插槽位置。目前暂时不用
__support_amd	String	是否是AMD架构类型的镜像。取值为“true”或者“false”。

请求示例

GET https://{endpoint}/v1/cloudimages/cn-north-4

响应示例

状态码：200

{
  "images" : [ {
    "id" : "633724a7-4a4e-11eb-8f73-fa1640aee23e",
    "name" : "ces",
    "status" : "active",
    "disk_format" : "zvhd2",
    "min_disk" : 40,
    "min_ram" : 0,
    "owner" : "2b76febbe5d34eac85d26435c1f15809",
    "protected" : false,
    "visibility" : "private",
    "created_at" : "2020-12-30T03:23:29Z",
    "updated_at" : "2020-12-30T03:30:36Z",
    "self" : "/v1/self/633724a7-4a4e-11eb-8f73-fa1640aee23e",
    "deleted" : false,
    "virtual_env_type" : "FusionCompute",
    "deleted_at" : "",
    "__imagetype" : "private",
    "__platform" : "CentOS",
    "__os_type" : "Linux",
    "__os_version" : "CentOS 7.4 64bit",
    "__isregistered" : true,
    "__support_arm" : "true",
    "hw_firmware_type" : "uefi",
    "data_source" : "instance:a7c6deda-99eb-4f58-b7b4-04a36b75401b",
    "__support_gpu_t4" : "true"
  } ]
}