華為云計(jì)算 云知識(shí) 查詢鏡像列表ListImages
查詢鏡像列表ListImages
時(shí)間: 2023-08-01 14:06:06
猜你想看：
實(shí)時(shí)語(yǔ)音識(shí)別 云服務(wù)器配置 CDN是什么意思 視頻點(diǎn)播加速 什么是云桌面

 

接口說(shuō)明

根據(jù)不同條件查詢 鏡像 列表信息。 可以在URI后面用‘?’和‘&’添加不同的查詢條件組合,請(qǐng)參考請(qǐng)求樣例。

URL
GET  https://ims.cn-north-1.myhuaweicloud.com/v2/cloudimages 
請(qǐng)求參數(shù)
名稱 類型 IN 必選 描述
X-Auth-Token
 
 string header 否

用戶Token,使用Token認(rèn)證時(shí)該字段必選。
X-Sdk-Date
 
 string header 否

請(qǐng)求的發(fā)生時(shí)間,格式為YYYYMMDDTHHMMSSZ。取值為當(dāng)前系統(tǒng)的GMT時(shí)間。使用AK/SK認(rèn)證時(shí)該字段必選
__imagetype
 
 string query 否

鏡像類型,目前支持以下類型: 公共鏡像:gold 私有鏡像:private 共享鏡像:shared 市場(chǎng)鏡像:market
__isregistered
 
 string query 否

鏡像是否可用,取值為true,擴(kuò)展接口會(huì)默認(rèn)為true,普通用戶只能查詢?nèi)≈禐閠rue的鏡像。
__os_bit
 
 string query 否

操作系統(tǒng)位數(shù),一般取值為32或者64。
__os_type
 
 string query 否

鏡像系統(tǒng)類型,取值為L(zhǎng)inux,Windows,Other。
__platform
 
 string query 否

鏡像平臺(tái)分類
__support_diskintensive
 
 string query 否

表示該鏡像支持密集存儲(chǔ)。如果鏡像支持密集存儲(chǔ)性能,則值為true,否則無(wú)需增加該屬性。
__support_highperformance
 
 string query 否

表示該鏡像支持高計(jì)算性能。如果鏡像支持高計(jì)算性能,則值為true,否則無(wú)需增加該屬性。
__support_kvm
 
 string query 否

如果鏡像支持KVM,取值為true,否則無(wú)需增加該屬性。
__support_kvm_gpu_type
 
 string query 否

表示該鏡像是支持KVM虛擬化平臺(tái)下的GPU類型,如果不支持KVM虛擬機(jī)下GPU類型,無(wú)需添加該屬性。該屬性與“__support_xen”和“__support_kvm”屬性不共存。
__support_kvm_infiniband
 
 string query 否

如果鏡像支持KVM虛擬化下Infiniband網(wǎng)卡類型,取值為true。否則,無(wú)需添加該屬性。該屬性與“__support_xen”屬性不共存。
__support_largememory
 
 string query 否

表示該鏡像支持超大內(nèi)存。如果鏡像支持超大內(nèi)存,取值為true,否則無(wú)需增加該屬性。
__support_xen
 
 string query 否

如果鏡像支持XEN,取值為true,否則無(wú)需增加該屬性。
__support_xen_gpu_type
 
 string query 否

表示該鏡像是支持XEN虛擬化平臺(tái)下的GPU優(yōu)化類型,如果不支持XEN虛擬化下GPU類型,無(wú)需添加該屬性 。該屬性與“__support_xen”和“__support_kvm”屬性不共存。
__support_xen_hana
 
 string query 否

如果鏡像支持XEN虛擬化下HANA類型,取值為true。否則,無(wú)需添加該屬性。該屬性與“__support_xen”和“__support_kvm”屬性不共存。
container_format
 
 string query 否

容器類型
disk_format
 
 string query 否

鏡像格式,目前支持vhd,zvhd、raw,qcow2,zvhd2。默認(rèn)值是vhd。
enterprise_project_id
 
 string query 否

表示查詢某個(gè)企業(yè)項(xiàng)目下的鏡像。 取值為0,表示查詢屬于default企業(yè)項(xiàng)目下的鏡像。 取值為UUID,表示查詢屬于該UUID對(duì)應(yīng)的企業(yè)項(xiàng)目下的鏡像。取值為all_granted_eps,表示查詢當(dāng)前用戶所有企業(yè)項(xiàng)目下的鏡像。 關(guān)于企業(yè)項(xiàng)目ID的獲取及企業(yè)項(xiàng)目特性的詳細(xì)信息,請(qǐng)參考《企業(yè)管理用戶指南》。
id
 
 string query 否

鏡像ID
limit
 
 integer query 否

用于分頁(yè),表示查詢幾條鏡像記錄,取值為整數(shù),默認(rèn)取值為500。
marker
 
 string query 否

用于分頁(yè),表示從哪個(gè)鏡像開始查詢,取值為鏡像ID。
member_status
 
 string query 否

成員狀態(tài)。目前取值有accepted、rejected、pending。accepted表示已經(jīng)接受共享的鏡像,rejected表示已經(jīng)拒絕了其他用戶共享的鏡像,pending表示需要確認(rèn)的其他用戶的共享鏡像。需要在查詢時(shí)設(shè)置“visibility”參數(shù)為“shared”。
min_disk
 
 integer query 否

鏡像運(yùn)行需要的最小磁盤,單位為GB 。取值為40~1024GB。
min_ram
 
 integer query 否

鏡像運(yùn)行需要的最小內(nèi)存,單位為MB。參數(shù)取值依據(jù)彈性 云服務(wù)器 的規(guī)格限制,一般設(shè)置為0。
name
 
 string query 否

鏡像名稱
owner
 
 string query 否

鏡像屬于哪個(gè)租戶
protected
 
 boolean query 否

鏡像是否是受保護(hù),取值為true/false,一般查詢公共鏡像時(shí)候取值為true,查詢私有鏡像可以不指定。
sort_dir
 
 string query 否

用于排序,表示升序還是降序,取值為asc和desc。與sort_key一起組合使用,默認(rèn)為降序desc。
sort_key
 
 string query 否

用于排序,表示按照哪個(gè)字段排序。取值為鏡像屬性name,container_format,disk_format,status ,id,size字段,默認(rèn)為創(chuàng)建時(shí)間。
status
 
 string query 否

鏡像狀態(tài)。取值如下: queued:表示鏡像元數(shù)據(jù)已經(jīng)創(chuàng)建成功,等待上傳鏡像文件。 saving:表示鏡像正在上傳文件到后端存儲(chǔ)。 deleted:表示鏡像已經(jīng)刪除。 killed:表示鏡像上傳錯(cuò)誤。 active:表示鏡像可以正常使用。
tag
 
 string query 否

標(biāo)簽,用戶為鏡像增加自定義標(biāo)簽后可以通過(guò)該參數(shù)過(guò)濾查詢。
virtual_env_type
 
 string query 否

鏡像使用環(huán)境類型:FusionCompute,Ironic,DataImage。如果彈性云服務(wù)器鏡像,則取值為FusionCompute,如果是數(shù)據(jù)卷鏡像則取值是DataImage,如果是 裸金屬服務(wù)器 鏡像,則取值是Ironic。
visibility
 
 string query 否

是否被其他租戶可見,取值為public或private
flavor_id
 
 string query 否

用于通過(guò)云服務(wù)器規(guī)格過(guò)濾出可用公共鏡像,取值為規(guī)格ID。 當(dāng)前僅支持通過(guò)單個(gè)規(guī)格進(jìn)行過(guò)濾。
created_at
 
 string query 否

鏡像創(chuàng)建時(shí)間。支持按照時(shí)間點(diǎn)過(guò)濾查詢,取值格式為“操作符:UTC時(shí)間”。 其中操作符支持如下幾種: gt:大于 gte:大于等于 lt:小于 lte:小于等于 eq:等于 neq:不等于 時(shí)間格式支持:yyyy-MM-ddThh:mm:ssZ或者yyyy-MM-dd hh:mm:ss 例如,查詢創(chuàng)建時(shí)間在2018-10-28 10:00:00之前的鏡像,可以通過(guò)如下條件過(guò)濾: created_at=gt:2018-10-28T10:00:00Z
updated_at
 
 string query 否

鏡像修改時(shí)間。支持按照時(shí)間點(diǎn)過(guò)濾查詢,取值格式為“ 操作符:UTC時(shí)間”。 其中操作符支持如下幾種: gt:大于 gte:大于等于 lt:小于 lte:小于等于 eq:等于 neq:不等于 時(shí)間格式支持:yyyy-MM-ddThh:mm:ssZ或者yyyy-MM-dd hh:mm:ss 例如,查詢修改時(shí)間在2018-10-28 10:00:00之前的鏡像,可以通過(guò)如下條件過(guò)濾: updated_at=gt:2018-10-28T10:00:00Z
architecture
 
 string query 否

鏡像架構(gòu)類型。取值包括: x86 arm
返回參數(shù)
返回碼: 200

正常

名稱 類型 必選 描述
images
 
 Array of ImageInfo objects 是

鏡像列表
200 images
名稱 類型 必選 描述
__backup_id
 
 string 否

備份ID。如果是備份創(chuàng)建的鏡像,則填寫為備份的ID,否則為空
__data_origin
 
 string 否

鏡像來(lái)源。公共鏡像為空
__description
 
 string 否

鏡像描述信息。 支持字母、數(shù)字、中文等,不支持回車、<、 >,長(zhǎng)度不能超過(guò)1024個(gè)字符。
__image_size
 
 string 是

鏡像文件的大小,單位為字節(jié)
__image_source_type
 
 string 是

鏡像后端存儲(chǔ)類型,目前只支持uds
__imagetype
 
 string 是

鏡像類型,目前支持以下類型: 公共鏡像:gold 私有鏡像:private 共享鏡像:shared 市場(chǎng)鏡像:market
__isregistered
 
 string 是

是否是注冊(cè)過(guò)的鏡像,取值為“true”或者“false”
__originalimagename
 
 string 否

父鏡像ID。公共鏡像或通過(guò)文件創(chuàng)建的私有鏡像,取值為空
__os_bit
 
 string 否

操作系統(tǒng)位數(shù),一般取值為“32”或者“64”
__os_type
 
 string 是

操作系統(tǒng)類型,目前取值Linux, Windows,Other
__os_version
 
 string 否

操作系統(tǒng)具體版本
__platform
 
 string 否

鏡像平臺(tái)分類
__productcode
 
 string 否

市場(chǎng)鏡像的產(chǎn)品ID
__support_diskintensive
 
 string 否

鏡像來(lái)源表示該鏡像支持密集存儲(chǔ)。如果鏡像支持密集存儲(chǔ)性能,則值為true,否則無(wú)需增加該屬性。
__support_highperformance
 
 string 否

表示該鏡像支持高計(jì)算性能。如果鏡像支持高計(jì)算性能,則值為true,否則無(wú)需增加該屬性。
__support_kvm
 
 string 否

如果鏡像支持KVM,取值為true,否則無(wú)需增加該屬性。
__support_kvm_gpu_type
 
 string 否

表示該鏡像是支持KVM虛擬化平臺(tái)下的GPU類型,如果不支持KVM虛擬機(jī)下GPU類型,無(wú)需添加該屬性。該屬性與“__support_xen”和“__support_kvm”屬性不共存。
__support_kvm_infiniband
 
 string 否

如果鏡像支持KVM虛擬化下Infiniband網(wǎng)卡類型,取值為true。否則,無(wú)需添加該屬性。該屬性與“__support_xen”屬性不共存。
__support_largememory
 
 string 否

表示該鏡像支持超大內(nèi)存。如果鏡像支持超大內(nèi)存,取值為true,否則無(wú)需增加該屬性。
__support_xen
 
 string 否

如果鏡像支持XEN,取值為true,否則無(wú)需增加該屬性。
__support_xen_gpu_type
 
 string 否

表示該鏡像是支持XEN虛擬化平臺(tái)下的GPU優(yōu)化類型,如果不支持XEN虛擬化下GPU類型,無(wú)需添加該屬性 。該屬性與“__support_xen”和“__support_kvm”屬性不共存。
__support_xen_hana
 
 string 否

如果鏡像支持XEN虛擬化下HANA類型,取值為true。否則,無(wú)需添加該屬性。該屬性與“__support_xen” 和“__support_kvm”屬性不共存。
__system_support_market
 
 boolean 否

表示當(dāng)前鏡像是否支持發(fā)布為市場(chǎng)鏡像,true表示支持,false 表示不支持
checksum
 
 string 否

目前暫時(shí)不使用
container_format
 
 string 是

容器類型
created_at
 
 string 是

創(chuàng)建時(shí)間。格式為UTC時(shí)間
disk_format
 
 string 否

鏡像的格式,目前支持vhd,zvhd、raw,qcow2。默認(rèn)值是vhd
enterprise_project_id
 
 string 否

表示當(dāng)前鏡像所屬的企業(yè)項(xiàng)目。取值為0或無(wú)該值,表示屬于default企業(yè)項(xiàng)目,取值為UUID,表示屬于該UUID對(duì)應(yīng)的企業(yè)項(xiàng)目。
file
 
 string 否

鏡像文件下載和上傳鏈接
id
 
 string 是

鏡像ID
min_disk
 
 integer 是

鏡像運(yùn)行需要的最小磁盤容量,單位為GB。取值為40~1024GB。
min_ram
 
 integer 是

鏡像運(yùn)行需要的最小內(nèi)存,單位為MB。參數(shù)取值依據(jù)彈性云服務(wù)器的規(guī)格限制,默認(rèn)設(shè)置為0
name
 
 string 是

鏡像名稱。 名稱的首尾字母不能為空格。 名稱的長(zhǎng)度至為1~128位。 名稱包含以下4種字符: 大寫字母 小寫字母 數(shù)字 特殊字符包含-、.、_、空格和中文。
owner
 
 string 是

鏡像屬于哪個(gè)租戶
protected
 
 boolean 是

是否是受保護(hù)的,受保護(hù)的鏡像不允許刪除。取值為true或false
schema
 
 string 否

鏡像視圖
self
 
 string 是

鏡像鏈接信息
size
 
 integer 否

目前暫時(shí)不使用
status
 
 string 是

鏡像狀態(tài)。取值如下:queued:表示鏡像元數(shù)據(jù)已經(jīng)創(chuàng)建成功,等待 上傳鏡像文件。saving:表示鏡像 正在上傳文件到后端存儲(chǔ)。deleted:表示鏡像已經(jīng)刪除。killed:表示鏡像上傳錯(cuò)誤。active:表示鏡像可以正常使用
tags
 
 Array of strings 是

鏡像標(biāo)簽列表
updated_at
 
 string 是

更新時(shí)間。格式為UTC時(shí)間
virtual_env_type
 
 string 是

鏡像使用環(huán)境類型:FusionCompute,Ironic,DataImage。如果彈性云服務(wù)器鏡像,則取值為FusionCompute,如果是數(shù)據(jù)卷鏡像則取Dat aImage,如果是裸金屬服務(wù)器鏡像,則取值是Ironic
virtual_size
 
 integer 否

目前暫時(shí)不使用
visibility
 
 string 是

是否被其他租戶可見,取值為private或public
__support_fc_inject
 
 string 否

表示當(dāng)前鏡像支持CloudInit密碼/密鑰注入方式,建議設(shè)置為"true"或者"false"。 如果取值為"true",表示該鏡像不支持CloudInit注入密碼/密鑰,其他取值時(shí)表示支持CloudInit注入密鑰/密碼。
hw_firmware_type
 
 string 否

云服務(wù)器的啟動(dòng)方式。目前支持: bios:表示bios引導(dǎo)啟動(dòng)。 uefi:表示uefi引導(dǎo)啟動(dòng)。
__support_arm
 
 string 否

是否是ARM架構(gòu)類型的鏡像,取值為“true”或者“false”。
max_ram
 
 string 否

鏡像支持的最大內(nèi)存,單位為MB。取值可以參考云服務(wù)器規(guī)格限制,一般不設(shè)置。
__system__cmkid
 
 string 否

加密鏡像所使用的密鑰ID。
__os_feature_list
 
 string 否

鏡像附加屬性。該屬性采用JSON格式來(lái)標(biāo)識(shí)鏡像支持的高級(jí)特性清單。
__account_code
 
 string 否

收費(fèi)鏡像標(biāo)識(shí)。
hw_vif_multiqueue_enabled
 
 string 否

鏡像是否支持網(wǎng)卡多隊(duì)列。取值為“true”或者“false”。
__is_offshelved
 
 string 否

表示當(dāng)前市場(chǎng)鏡像是否下架。true:已下架 false:未下架
__lazyloading
 
 string 否

鏡像是否支持延遲加載。取值為“True”或“False”。
__root_origin
 
 string 否

表示當(dāng)前鏡像來(lái)源是從外部導(dǎo)入。取值:file。
__sequence_num
 
 string 否

表示當(dāng)前鏡像對(duì)應(yīng)云服務(wù)器的系統(tǒng)盤插槽位置。目前暫時(shí)不用
active_at
 
 string 是

鏡像狀態(tài)變?yōu)檎５臅r(shí)間。
__support_agent_list
 
 string 否

鏡像是否支持 企業(yè)主機(jī)安全 或主機(jī)監(jiān)控。 hss:企業(yè) 主機(jī)安全 ces:主機(jī)監(jiān)控
__support_amd
 
 string 否

是否是AMD架構(gòu)類型的鏡像。取值為“true”或者“false”。
返回碼: 400

Bad Request 請(qǐng)求錯(cuò)誤。

名稱 類型 必選 描述
error
 
 ErrorMessageInfo object 是

請(qǐng)求失敗響應(yīng)體
400 error
名稱 類型 必選 描述
code
 
 string 是

錯(cuò)誤碼
message
 
 string 是

錯(cuò)誤信息
返回碼: 401

Unauthorized 鑒權(quán)失敗。

名稱 類型 必選 描述
error
 
 ErrorMessageInfo object 是

請(qǐng)求失敗響應(yīng)體
401 error
名稱 類型 必選 描述
code
 
 string 是

錯(cuò)誤碼
message
 
 string 是

錯(cuò)誤信息
返回碼: 403

Forbidden 沒有操作權(quán)限。

名稱 類型 必選 描述
error
 
 ErrorMessageInfo object 是

請(qǐng)求失敗響應(yīng)體
403 error
名稱 類型 必選 描述
code
 
 string 是

錯(cuò)誤碼
message
 
 string 是

錯(cuò)誤信息
返回碼: 404

Not Found 找不到資源。

名稱 類型 必選 描述
error
 
 ErrorMessageInfo object 是

請(qǐng)求失敗響應(yīng)體
404 error
名稱 類型 必選 描述
code
 
 string 是

錯(cuò)誤碼
message
 
 string 是

錯(cuò)誤信息
返回碼: 500

Internal Server Error 服務(wù)內(nèi)部錯(cuò)誤。

名稱 類型 必選 描述
error
 
 ErrorMessageInfo object 是

請(qǐng)求失敗響應(yīng)體
500 error
名稱 類型 必選 描述
code
 
 string 是

錯(cuò)誤碼
message
 
 string 是

錯(cuò)誤信息
返回碼: 503

Service Unavailable 服務(wù)不可用。

名稱 類型 必選 描述
error
 
 ErrorMessageInfo object 是

請(qǐng)求失敗響應(yīng)體
503 error
名稱 類型 必選 描述
code
 
 string 是

錯(cuò)誤碼
message
 
 string 是

錯(cuò)誤信息
請(qǐng)求示例
示例 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
點(diǎn)擊  鏡像服務(wù)  (IMS) SDK, 下載SDK或查看SDK文檔。SDK的安裝、認(rèn)證方式等在SDK文檔中對(duì)應(yīng)語(yǔ)言類型的【使用】目錄下。
錯(cuò)誤碼
請(qǐng)參考 錯(cuò)誤碼說(shuō)明。

查詢鏡像列表ListImages

意見反饋

0/200

提交 取消

提交成功！非常感謝您的反饋，我們會(huì)繼續(xù)努力做到更好 反饋提交失?。≌?qǐng)稍后重試！