跳到主要内容

查詢映象

描述

查詢映象資訊,查詢一條或者多條可用映象資訊,可根據標識、作業系統標識、用途、名稱等條件查詢。

預設查詢出公有映象,如果查詢出自定義映象,Shared需要傳false。

請求引數

引數名引數型別是否必填引數說明
ActionString操作方法:DescribeImages
RegionString機房標識,取值參見地域列表
OffsetInteger記錄偏移量,不指定取 0
CountString記錄數量,不指定為全部
Id.NString映象id,支援批次,N為自然數,格式:&Id.0=xxx&Id.1=xxx等
NameString名稱

返回引數

名稱型別說明
ActionString執行的操作
TaskIdString請求標識
TotalCountInteger過濾條件下總共記錄數
ImageSetImageSetItemType由ImageSetItemType 組成的陣列格式,返回映象的資訊

ImageSetItemType

映象資訊的資料型別

名稱型別說明
IdString映象標識
NameString名稱
DescriptionString描述
SizeInteger大小,單位為 GiB
OsIdString作業系統ID
OsNameString作業系統名稱
SharedString是否共享
OwnerString所有者
StatusBoolean狀態NORMAL, CREATING;
UseString用途:雲主機(INSTANCE),SPARK(暫定),RDS
HotUpgradeBoolean是否支援熱升級 true false
CreateTimeDateTime建立時間
InstanceNumInteger透過映象建立的雲主機數量
templateImageTypeString模板型別

請求示例

https://api.yunpanel.com/v2/?Action=DescribeImages
&Region=cn-wuxi1
&AccessKeyId=6792aa42d288422ab8dd4654dfe727c4
&Date=2017-08-29T02%3A54%3A06%20%2B0000
&Id.0=t-3a8hh7se5j57w
&公共引數

返回示例

{
"code": 10000,
"message": "",
"data": {
"TaskId": "bmu8h20170829105344467",
"Action": "DescribeImages",
"TotalCount": 1,
"ImageSet": [
{
"Id": "t-3a8hh7se5j57w",
"Name": "tse13",
"Description": null,
"OsId": "o-35g8eada2l",
"OsName": "Windows2008 64",
"Shared": false,
"Owner": "18359988",
"CreateTime": "2017-08-28T14: 41: 55 +0800",
"Use": "INSTANCE",
"HotUpgrade": false,
"Size": 40,
"Status": "NORMAL",
"InstanceNum": 0,
"TemplateName": "tse13",
"TemplateImageType": "rbd"
}
]
}
}