华为云计算 云知识 查询镜像列表ListImages

普惠上云 2核2G2M云服务器

38元/年

云服务器秒杀 X实例-4核8G5M

338元/年

Flexus L实例 2核2G3M云服务器

68元/年

网站搭建 买3年送2年

1元/天

查询镜像列表ListImages
时间: 2023-08-01 14:06:06
API网关 云服务器 云主机 云计算 弹性伸缩
猜你想看：
实时语音识别 云服务器配置 CDN是什么意思 视频点播加速 什么是云桌面

 

接口说明

根据不同条件查询 镜像 列表信息。 可以在URI后面用‘?’和‘&’添加不同的查询条件组合,请参考请求样例。

URL
GET  https://ims.cn-north-1.myhuaweicloud.com/v2/cloudimages 
请求参数
名称 类型 IN 必选 描述
X-Auth-Token
 
 string header 否

用户Token,使用Token认证时该字段必选。
X-Sdk-Date
 
 string header 否

请求的发生时间,格式为YYYYMMDDTHHMMSSZ。取值为当前系统的GMT时间。使用AK/SK认证时该字段必选
__imagetype
 
 string query 否

镜像类型,目前支持以下类型: 公共镜像:gold 私有镜像:private 共享镜像:shared 市场镜像:market
__isregistered
 
 string query 否

镜像是否可用,取值为true,扩展接口会默认为true,普通用户只能查询取值为true的镜像。
__os_bit
 
 string query 否

操作系统位数,一般取值为32或者64。
__os_type
 
 string query 否

镜像系统类型,取值为Linux,Windows,Other。
__platform
 
 string query 否

镜像平台分类
__support_diskintensive
 
 string query 否

表示该镜像支持密集存储。如果镜像支持密集存储性能,则值为true,否则无需增加该属性。
__support_highperformance
 
 string query 否

表示该镜像支持高计算性能。如果镜像支持高计算性能,则值为true,否则无需增加该属性。
__support_kvm
 
 string query 否

如果镜像支持KVM,取值为true,否则无需增加该属性。
__support_kvm_gpu_type
 
 string query 否

表示该镜像是支持KVM虚拟化平台下的GPU类型,如果不支持KVM虚拟机下GPU类型,无需添加该属性。该属性与“__support_xen”和“__support_kvm”属性不共存。
__support_kvm_infiniband
 
 string query 否

如果镜像支持KVM虚拟化下Infiniband网卡类型,取值为true。否则,无需添加该属性。该属性与“__support_xen”属性不共存。
__support_largememory
 
 string query 否

表示该镜像支持超大内存。如果镜像支持超大内存,取值为true,否则无需增加该属性。
__support_xen
 
 string query 否

如果镜像支持XEN,取值为true,否则无需增加该属性。
__support_xen_gpu_type
 
 string query 否

表示该镜像是支持XEN虚拟化平台下的GPU优化类型,如果不支持XEN虚拟化下GPU类型,无需添加该属性 。该属性与“__support_xen”和“__support_kvm”属性不共存。
__support_xen_hana
 
 string query 否

如果镜像支持XEN虚拟化下HANA类型,取值为true。否则,无需添加该属性。该属性与“__support_xen”和“__support_kvm”属性不共存。
container_format
 
 string query 否

容器类型
disk_format
 
 string query 否

镜像格式,目前支持vhd,zvhd、raw,qcow2,zvhd2。默认值是vhd。
enterprise_project_id
 
 string query 否

表示查询某个企业项目下的镜像。 取值为0,表示查询属于default企业项目下的镜像。 取值为UUID,表示查询属于该UUID对应的企业项目下的镜像。取值为all_granted_eps,表示查询当前用户所有企业项目下的镜像。 关于企业项目ID的获取及企业项目特性的详细信息,请参考《企业管理用户指南》。
id
 
 string query 否

镜像ID
limit
 
 integer query 否

用于分页,表示查询几条镜像记录,取值为整数,默认取值为500。
marker
 
 string query 否

用于分页,表示从哪个镜像开始查询,取值为镜像ID。
member_status
 
 string query 否

成员状态。目前取值有accepted、rejected、pending。accepted表示已经接受共享的镜像,rejected表示已经拒绝了其他用户共享的镜像,pending表示需要确认的其他用户的共享镜像。需要在查询时设置“visibility”参数为“shared”。
min_disk
 
 integer query 否

镜像运行需要的最小磁盘,单位为GB 。取值为40~1024GB。
min_ram
 
 integer query 否

镜像运行需要的最小内存,单位为MB。参数取值依据弹性 云服务器 的规格限制,一般设置为0。
name
 
 string query 否

镜像名称
owner
 
 string query 否

镜像属于哪个租户
protected
 
 boolean query 否

镜像是否是受保护,取值为true/false,一般查询公共镜像时候取值为true,查询私有镜像可以不指定。
sort_dir
 
 string query 否

用于排序,表示升序还是降序,取值为asc和desc。与sort_key一起组合使用,默认为降序desc。
sort_key
 
 string query 否

用于排序,表示按照哪个字段排序。取值为镜像属性name,container_format,disk_format,status ,id,size字段,默认为创建时间。
status
 
 string query 否

镜像状态。取值如下: queued:表示镜像元数据已经创建成功,等待上传镜像文件。 saving:表示镜像正在上传文件到后端存储。 deleted:表示镜像已经删除。 killed:表示镜像上传错误。 active:表示镜像可以正常使用。
tag
 
 string query 否

标签,用户为镜像增加自定义标签后可以通过该参数过滤查询。
virtual_env_type
 
 string query 否

镜像使用环境类型:FusionCompute,Ironic,DataImage。如果弹性云服务器镜像,则取值为FusionCompute,如果是数据卷镜像则取值是DataImage,如果是 裸金属服务器 镜像,则取值是Ironic。
visibility
 
 string query 否

是否被其他租户可见,取值为public或private
flavor_id
 
 string query 否

用于通过云服务器规格过滤出可用公共镜像,取值为规格ID。 当前仅支持通过单个规格进行过滤。
created_at
 
 string query 否

镜像创建时间。支持按照时间点过滤查询,取值格式为“操作符:UTC时间”。 其中操作符支持如下几种: gt:大于 gte:大于等于 lt:小于 lte:小于等于 eq:等于 neq:不等于 时间格式支持:yyyy-MM-ddThh:mm:ssZ或者yyyy-MM-dd hh:mm:ss 例如,查询创建时间在2018-10-28 10:00:00之前的镜像,可以通过如下条件过滤: created_at=gt:2018-10-28T10:00:00Z
updated_at
 
 string query 否

镜像修改时间。支持按照时间点过滤查询,取值格式为“ 操作符:UTC时间”。 其中操作符支持如下几种: gt:大于 gte:大于等于 lt:小于 lte:小于等于 eq:等于 neq:不等于 时间格式支持:yyyy-MM-ddThh:mm:ssZ或者yyyy-MM-dd hh:mm:ss 例如,查询修改时间在2018-10-28 10:00:00之前的镜像,可以通过如下条件过滤: updated_at=gt:2018-10-28T10:00:00Z
architecture
 
 string query 否

镜像架构类型。取值包括: x86 arm
返回参数
返回码: 200

正常

名称 类型 必选 描述
images
 
 Array of ImageInfo objects 是

镜像列表
200 images
名称 类型 必选 描述
__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优化类型,如果不支持XEN虚拟化下GPU类型,无需添加该属性 。该属性与“__support_xen”和“__support_kvm”属性不共存。
__support_xen_hana
 
 string 否

如果镜像支持XEN虚拟化下HANA类型,取值为true。否则,无需添加该属性。该属性与“__support_xen” 和“__support_kvm”属性不共存。
__system_support_market
 
 boolean 否

表示当前镜像是否支持发布为市场镜像,true表示支持,false 表示不支持
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
__support_fc_inject
 
 string 否

表示当前镜像支持CloudInit密码/密钥注入方式,建议设置为"true"或者"false"。 如果取值为"true",表示该镜像不支持CloudInit注入密码/密钥,其他取值时表示支持CloudInit注入密钥/密码。
hw_firmware_type
 
 string 否

云服务器的启动方式。目前支持: bios:表示bios引导启动。 uefi:表示uefi引导启动。
__support_arm
 
 string 否

是否是ARM架构类型的镜像,取值为“true”或者“false”。
max_ram
 
 string 否

镜像支持的最大内存,单位为MB。取值可以参考云服务器规格限制,一般不设置。
__system__cmkid
 
 string 否

加密镜像所使用的密钥ID。
__os_feature_list
 
 string 否

镜像附加属性。该属性采用JSON格式来标识镜像支持的高级特性清单。
__account_code
 
 string 否

收费镜像标识。
hw_vif_multiqueue_enabled
 
 string 否

镜像是否支持网卡多队列。取值为“true”或者“false”。
__is_offshelved
 
 string 否

表示当前市场镜像是否下架。true:已下架 false:未下架
__lazyloading
 
 string 否

镜像是否支持延迟加载。取值为“True”或“False”。
__root_origin
 
 string 否

表示当前镜像来源是从外部导入。取值:file。
__sequence_num
 
 string 否

表示当前镜像对应云服务器的系统盘插槽位置。目前暂时不用
active_at
 
 string 是

镜像状态变为正常的时间。
__support_agent_list
 
 string 否

镜像是否支持 企业主机安全 或主机监控。 hss:企业 主机安全 ces:主机监控
__support_amd
 
 string 否

是否是AMD架构类型的镜像。取值为“true”或者“false”。
返回码: 400

Bad Request 请求错误。

名称 类型 必选 描述
error
 
 ErrorMessageInfo object 是

请求失败响应体
400 error
名称 类型 必选 描述
code
 
 string 是

错误码
message
 
 string 是

错误信息
返回码: 401

Unauthorized 鉴权失败。

名称 类型 必选 描述
error
 
 ErrorMessageInfo object 是

请求失败响应体
401 error
名称 类型 必选 描述
code
 
 string 是

错误码
message
 
 string 是

错误信息
返回码: 403

Forbidden 没有操作权限。

名称 类型 必选 描述
error
 
 ErrorMessageInfo object 是

请求失败响应体
403 error
名称 类型 必选 描述
code
 
 string 是

错误码
message
 
 string 是

错误信息
返回码: 404

Not Found 找不到资源。

名称 类型 必选 描述
error
 
 ErrorMessageInfo object 是

请求失败响应体
404 error
名称 类型 必选 描述
code
 
 string 是

错误码
message
 
 string 是

错误信息
返回码: 500

Internal Server Error 服务内部错误。

名称 类型 必选 描述
error
 
 ErrorMessageInfo object 是

请求失败响应体
500 error
名称 类型 必选 描述
code
 
 string 是

错误码
message
 
 string 是

错误信息
返回码: 503

Service Unavailable 服务不可用。

名称 类型 必选 描述
error
 
 ErrorMessageInfo object 是

请求失败响应体
503 error
名称 类型 必选 描述
code
 
 string 是

错误码
message
 
 string 是

错误信息
请求示例
示例 1
 
"GET https://{Endpoint}/v2/cloudimages?__imagetype=gold&sort_key=name&limit=1"
返回示例
返回码：200

正常

示例 1
 
{
"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",
"__support_kvm_fpga_type": "VU9P",
"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,
"status": "active",
"__support_fc_inject": "true"
},
{
"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",
"__support_kvm_fpga_type": "VU9P_COMMON",
"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,
"status": "active"
}
]
}
SDK
点击  镜像服务  (IMS) SDK, 下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
错误码
请参考 错误码说明。

上一篇：视频人物分析 下一篇：弹性云服务器怎么样购买划算？

镜像服务 IMS

镜像是用于创建服务器或磁盘的模板。镜像服务提供镜像生命周期管理能力。可以通过服务器或外部文件创建系统盘镜像或数据盘镜像，也可以使用弹性云服务器或云服务器备份创建带数据盘的整机镜像。创建镜像功能免费，仅需支付使用对象存储服务或云服务器备份的费用。

 
产品详情立即注册一元域名华为云桌面
 
[免费体验中心]免费领取体验产品，快速开启云上之旅免费
 

猜你喜欢

最新文章

云服务器0元领取 | 免费体验云产品
查询镜像列表ListImages

您找到想要的内容了吗?

是的 没有

意见反馈

0/200

提交 取消

提交成功！非常感谢您的反馈，我们会继续努力做到更好 反馈提交失败！请稍后重试！
推荐内容
相关专题

更多内容

怎么制作一个网站 商标注册流程及费用 Email注册网站 免费网站申请域名 新用户优惠 华为折扣券哪里领 云服务器代金券 文字识别平台 NPM镜像下载 Manjaro镜像下载
域名是什么
展开全部收起全部