跳到主要内容

查詢自定義映象

描述

查詢自定義映象列表。

請求引數

引數名引數型別是否必填引數說明
ActionString操作方法:ListCloudPhoneCustomImage,此引數為公共引數,不必放body裡面
RegionString機房標識,取值參見地域列表
KeyString關鍵字查詢,可以查詢映象名稱、映象ID、映象UUID
RootImageIdString原始映象ID
StatusString映象狀態 NORMAL:正常 CREATING:建立中 CREATE_FAIL:建立失敗
CreateStartTimeInteger建立開始時間戳,精確到毫秒,如1591344325000
CreateEndTimeInteger建立結束時間戳,精確到毫秒,如1591344325000
PageNoInteger頁碼,預設第1頁,PageNo和PageSize都不傳返回全部資料
PageSizeInteger每頁數量,預設10條
ProductModelIdsArray產品型號陣列

返回引數

名稱型別說明
PagePage由Page組成的陣列格式,返回分頁資訊,PageNo和PageSize都不傳時不會返回該資訊
ListList由List組成的陣列格式,返回自定義映象列表資訊

Page

分頁資訊的資料型別

名稱型別說明
PageSizeInteger頁面總數
CurrentPageNoInteger當前分頁數
TotalPageInteger總頁數
TotalCountInteger總數

List

自定義映象列表的資料型別

名稱型別說明
IdString映象ID
UuidString映象UUID
NameString映象名稱
RootImageIdString原始映象ID
RootImageNameString原始映象名稱
ProductModelIdsArray產品型號ID列表
StorageInteger儲存大小,單位GB
IsRootInteger是否root 0否 1是
DescriptionString映象描述
StatusString映象狀態 NORMAL:正常 CREATING:建立中 CREATE_FAIL:建立失敗
CreateTimeInteger建立時間戳,精確到毫秒
UpdateTimeInteger修改時間戳,精確到毫秒

請求示例

post https://api.yunpanel.com/v2/?Action=ListCloudPhoneCustomImage&其他公共引數

返回示例

{
"code": 10000,
"message": "",
"data": {
"Page": {
"PageSize": 10,
"CurrentPageNo": 1,
"TotalPage": 1,
"TotalCount": 3
},
"List":[{
"Id": "aaaaaa",
"Uuid": "f5f72a07-5de3-4328-8863-537433c7042d",
"Name": "A2004210005",
"RootImageId": "bbbbb",
"RootImageName": "ccccc",
"ProductModelIds": [805013, 805014, 805015],
"Storage": 40,
"IsRoot": 1,
"Description": "xxxxx",
"Status": "NORMAL",
"CreateTime": 1591344325000,
"UpdateTime": 1591344325000
}, {
"Id": "bbbbbb",
"Uuid": "f5f72a07-5de3-4328-8863-537433c7042e",
"Name": "A2004210006",
"RootImageId": "bbbbb",
"RootImageName": "ccccc",
"ProductModelIds": [805013, 805014, 805015],
"Storage": 40,
"IsRoot": 1,
"Description": "xxxxx",
"Status": "NORMAL",
"CreateTime": 1591344325000,
"UpdateTime": 1591344325000
}]
}
}