監控指標數據排序
更新時間 2023-07-19 11:40:59
最近更新時間: 2023-07-19 11:40:59
分享文章
接口功能介紹
查詢單個(ge)用戶在某個(ge)資源(yuan)池(chi)下某種(zhong)設備類型的監控指(zhi)標由高(gao)到(dao)低的順序(xu)
接口約束
regionID（資(zi)源(yuan)池(chi)）、deviceUUIDList（設備(bei)資(zi)源(yuan)）、itemNameList（待查(cha)監控項名(ming)稱）存在(zai)。
URI
POST /v4/monitor/query-metricdata-top
請求參數
請求體body參數
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 資源池ID | |
| deviceType | String | 是 | vm | 本參數表示設備類型，目前僅支持云主機。取值范圍：vm：云主機。根據以上范圍取值。 | |
| itemNameList | Array of String | 是 | ["disk_util"] | 待查的監控項名稱 | |
| deviceUUIDList | Array of String | 否 | ["3080069a-ca2b-fca1-f038-5e6e00dd7630"] | 查詢設備ID列表，不傳默認返回該用戶下指定類型的所有設備 | |
| number | Integer | 否 | 2 | 返回用戶在該資源池下某個設備類型監控值最大的前N個設備信息，默認為5 | |
| pageNo | Integer | 否 | 1 | 頁碼，默認為1 | |
| page | Integer | 否 | 1 | 頁碼，默認為1，建議使用pageNo，該參數后續會下線 | |
| pageSize | Integer | 否 | 2 | 頁大小，默認為20 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| returnObj | Object | 返回對象 | returnObj |
表returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| result | Array of Objects | 返回數據結果 | result | |
| totalCount | Integer | 獲取對象數據條數 | 14 | |
| totalPage | Integer | 總頁數 | 1 | |
| currentCount | Integer | 當前頁記錄數 | 14 | |
| page | Integer | 頁碼，建議參考請求參數pageNo，該參數后續會下線 | 1 | |
| pageSize | Integer | 頁大小，建議參考請求參數pageSize，該參數后續會下線 | 10 |
表result
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| deviceType | String | 設備類型 | vm | |
| regionID | String | 所屬資源池ID | 81f7728662dd11ec810800155d307d5b | |
| regionName | String | 資源池名稱 | nm8 | |
| fuserLastUpdated | String | 最近更新時間 | 2022-11-07 18:25:12 | |
| itemList | Array of Objects | 返回監控項列表 | itemList |
表itemList
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| {itemName} | String | 監控項名稱 | disk_util | |
| {deviceInfoList} | Array of Objects | 設備信息取值數組 | deviceInfoList |
表deviceInfoList
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| deviceUUID | String | 設備uuid | 3080069a-ca2b-fca1-f038-5e6e00dd7630 | |
| samplingTime | Integer | 監控數據采樣時間 | 1667815639 | |
| value | Double | 監控項值，具體請參考對應監控項文檔 | 524288 |
請求示例
POST /v4/monitor/query-metricdata-top
請求體body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"deviceType":"vm",
"itemNameList": [
"disk_util",
"cpu_util",
"mem_util"
],
"number":2
}
響應示例
{
"statusCode":800,
"returnObj":{
"result":[
{
"deviceType":"vm",
"fuserLastUpdated":"2022-10-20 10:11:46",
"regionID":"73f321ea-62ff-11ec-a8bc-005056898fe0",
"regionName":"nm8",
"itemsList":[
[
{
"disk_util":[
{
"deviceUUID":"3080069a-ca2b-fca1-f038-5e6e00dd7630",
"name":"ecm-be47",
"value":"46.7587"
},
{
"deviceUUID":"b7862cdf-6b1b-bdfd-8410-ba71d2a7ecb8",
"name":"ecm-71e7",
"value":"46.7581"
}
]
},
{
"cpu_util":[
{
"deviceUUID":"b7862cdf-6b1b-bdfd-8410-ba71d2a7ecb8",
"name":"ecm-71e7",
"value":"0.6501"
},
{
"deviceUUID":"3080069a-ca2b-fca1-f038-5e6e00dd7630",
"name":"ecm-be47",
"value":"0.5505"
}
]
},
{
"mem_util":[
{
"deviceUUID":"b7862cdf-6b1b-bdfd-8410-ba71d2a7ecb8",
"name":"ecm-71e7",
"value":"81.1625"
},
{
"deviceUUID":"43eaf44d-aa29-ceee-7ac1-32d3251b3c29",
"name":"as-config-82abuz79",
"value":"80.185"
}
]
}
]
]
}
],
"totalCount": 4,
"currentCount": 4,
"totalPage": 1,
"page": 1,
"pageSize": 20
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.DataQuery.AccessFailed | 訪問內部系統失敗 |
| Monitor.DataQuery.ResponseError | 訪問內部系統返回錯誤 |
| 其他 | 參見公共錯誤碼說明 |
