實時監控數據：查詢v4.2
更新時間 2024-11-08 09:43:12
最近更新時間: 2024-11-08 09:43:12
分享文章
實時監控數據查詢
實時監控數據：查詢
接口功能介紹
查詢指定設備的實時監控數據。
接口約束
參見請求參數說明。
URI
POST /v4.2/monitor/query-latest-metric-data
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| service | 是 | String | 云監控服務，具體服務參見云監控：查詢服務維度及監控項 | ecs | |
| dimension | 是 | String | 云監控維度，具體維度參見云監控：查詢服務維度及監控項 | ecs | |
| itemNameList | 是 | Array of Strings | 待查監控項名稱，單次請求長度限制為10，具體設備對應監控項參見云監控：查詢服務維度及監控項 | ['cpu_util','disk_write_bytes_rate'] | |
| dimensions | 是 | Array of Objects | 查詢設備標簽列表，用于定位目標設備，多標簽查詢取交集，單次請求設備數量限制為10 | dimension |
表 dimension
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| name | 是 | String | 設備標簽鍵 | uuid | |
| value | 是 | Array of Strings | 設備標簽鍵所對應的值，最大數量限制為10 | ['9dc48979-4e19-45e2-b523-5d3c70d516b3'] |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回對象 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| itemList | Array of Objects | 監控項數據 | itemList |
表 itemList
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| itemName | String | 監控項名稱，具體設備對應監控項參見云監控：查詢服務維度及監控項 | cpu_util | |
| itemDesc | String | 監控項中文介紹 | CPU使用率 | |
| itemUnit | String | 監控項單位 | bit/s | |
| value | Float | 監控項值，具體請參考對應監控項文檔 | 0.2169 | |
| timestamp | Integer | 監控數據采樣Unix時間戳 | 1667816712 | |
| dimensions | Array of Objects | 監控項標簽 | dimension |
表 dimension
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| name | String | 監控項標簽鍵 | uuid | |
| value | String | 監控項標簽鍵對應的值 | 9dc48979-4e19-45e2-b523-5d3c70d516b3 |
請求示例
請求url
/v4.2/monitor/query-latest-metric-data
請求頭header
無
請求體body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"service":"ecs",
"dimension":"ecs",
"itemNameList":[
"cpu_util",
"disk_util"
],
"dimensions":[
{
"name":"uuid",
"value":[
"000f0322-1f4d-8cc8-bb2e-1c30fb751aa5",
"00229aa9-ce6b-b46f-4b7d-df61f48a5903"
]
}
]
}
響應示例
{
"statusCode":800,
"returnObj":{
"itemList":[
{
"itemName":"cpu_util",
"itemDesc":"CPU使用率",
"itemUnit":"%",
"value":0.2169,
"timestamp":1666251788,
"dimensions":[
{
"name":"uuid",
"value":"000f0322-1f4d-8cc8-bb2e-1c30fb751aa5"
}
]
},
{
"itemName":"disk_util",
"itemDesc":"磁盤使用率",
"itemUnit":"%",
"value":7.6032,
"timestamp":1666251788,
"dimensions":[
{
"name":"uuid",
"value":"000f0322-1f4d-8cc8-bb2e-1c30fb751aa5"
}
]
}
]
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Openapi.RegionInfo.Empty | 找不到資源池 |
| Openapi.Parameter.Error | 請求參數錯誤，可能是未傳入必填項、參數類型錯誤、參數范圍錯誤 |
| Monitor.DataQuery.AccessFailed | 訪問內部系統失敗 |
| Monitor.DataQuery.ResponseError | 訪問內部系統返回錯誤 |
