資源列表查詢：裸物理機
更新時間(jian) 2023-07-19 11:41:00
最近更新時間: 2023-07-19 11:41:00
分享文(wen)章(zhang)
接口功能介紹
根(gen)據篩(shai)選條件查詢(xun)資源池(chi)下裸物理(li)機的(de)列表。
接口約束
regionID（資(zi)源池）存在。
URI
GET /v4/monitor/query-pms-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 | 裸物理機總記錄數 | 34 | |
| list | Array of Objects | 裸物理機資源列表 | pms |
表pms
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| deviceUUID | String | 唯一標識ID | ss-n9p9xaepormwzuatdkz6bobsqmld | |
| instanceID | String | 實例ID | ss-n9p9xaepormwzuatdkz6bobsqmld | |
| instanceName | String | 裸物理機實例名稱 | pm-2c50 |
請求示例
GET /v4/monitor/query-pms-list?regionID=81f7728662dd11ec810800155d307d5b&page=1&pageSize=6
響應示例
{
"statusCode": 800,
"returnObj": {
"page": 1,
"pageSize": 6,
"totalPage":1,
"currentCount":5,
"totalCount": 5,
"list": [
{
"deviceUUID": "ss-n9p9xaepormwzuatdkz6bobsqmld",
"instanceID": "ss-n9p9xaepormwzuatdkz6bobsqmld",
"instanceName": "pm-2c50"
},
{
"deviceUUID": "b8c133b5-3de2-4e99-87c2-e37a380f9c05",
"instanceID": "b8c133b5-3de2-4e99-87c2-e37a380f9c05",
"instanceName": "pm-1a84"
},
{
"deviceUUID": "ss-vajifp4e2xbwticydinxqgs0kouc",
"instanceID": "ss-vajifp4e2xbwticydinxqgs0kouc",
"instanceName": "pm-replace"
},
{
"deviceUUID": "72d89cbe-abc3-4ca9-ab59-3defadb9f2fc",
"instanceID": "72d89cbe-abc3-4ca9-ab59-3defadb9f2fc",
"instanceName": "P-a7de-SGDz"
},
{
"deviceUUID": "ss-zj00ujb0o5dfwxdxzvxgl3ink9gw",
"instanceID": "ss-zj00ujb0o5dfwxdxzvxgl3ink9gw",
"instanceName": "pm-62bb"
}
]
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
