資源列表查詢：云主機
更(geng)新(xin)時間 2023-07-19 11:41:00
最近更(geng)新時間(jian): 2023-07-19 11:41:00
分享文章
接口功能介紹
根據篩(shai)選條(tiao)件查詢資源池(chi)下云主機的列表(biao)。
接口約束
regionID（資源池(chi)）存在。
URI
GET /v4/monitor/query-ecs-list
請求參數
Query參數
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 資源池ID | |
| pageNo | Integer | 否 | 1 | 頁碼，默認為1 | |
| page | Integer | 否 | 1 | 頁碼，默認為1，建議使用pageNo，該參數后續會下線 | |
| pageSize | Integer | 否 | 1 | 頁大小，默認為10 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| returnObj | Object | 返回對象 | returnObj |
表returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| page | Integer | 頁碼 | 1 | |
| pageSize | Integer | 頁大小 | 3 | |
| totalPage | Integer | 總頁數 | 1 | |
| currentCount | Integer | 當前頁記錄數 | 2 | |
| totalCount | Integer | 云主機總記錄數 | 30 | |
| list | Array of Objects | 云主機資源列表 | ecs |
表ecs
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| deviceUUID | String | 唯一標識ID | 478349bf-5576-26d2-3612-d47d72aa4d85 | |
| instanceID | String | 實例ID | 478349bf-5576-26d2-3612-d47d72aa4d85 | |
| instanceName | String | 云主機實例名稱 | ecm-120fxstset |
請求示例
GET /v4/monitor/query-ecs-list?regionID=81f7728662dd11ec810800155d307d5b&page=1&pageSize=3
響應示例
{
"statusCode": 800,
"returnObj": {
"page": 1,
"pageSize": 3,
"totalPage":10,
"currentCount":3,
"totalCount": 30,
"list": [
{
"deviceUUID": "478349bf-5576-26d2-3612-d47d72aa4d85",
"instanceID": "478349bf-5576-26d2-3612-d47d72aa4d85",
"instanceName": "ecm-120fxstset"
},
{
"deviceUUID": "6bad8880-c9dc-6f86-2494-725351eab69a",
"instanceID": "6bad8880-c9dc-6f86-2494-725351eab69a",
"instanceName": "ecm-7626"
},
{
"deviceUUID": "8603be6c-57d7-bc22-a5e0-bb42cbe69281",
"instanceID": "8603be6c-57d7-bc22-a5e0-bb42cbe69281",
"instanceName": "ecm-7626"
}
]
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
