自定義監控項：查詢
更新時間 2024-09-25 16:20:51
最近更新時間: 2024-09-25 16:20:51
分享文章
自定義監控項
自定義監控項：查詢
接口功能介紹
調用此接口可查詢自定義監控項。
接口約束
資源池ID不能為空。
URI
GET /v4/monitor/query-custom-items
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| customItemID | 否 | String | 自定義監控項ID | ITEM793d5923652be6ce202306291409 | |
| name | 否 | String | 監控項名稱，支持模糊搜索 | 我的CPU使用率 | |
| pageNo | 否 | Integer | 頁碼，不傳默認為1 | 1 | |
| pageSize | 否 | Integer | 每頁大小，不傳默認為10 | 10 |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回參數，參考returnObj對象結構 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| customItemList | Array of Objects | 自定義監控項列表 | customItem | |
| totalCount | Integer | 總記錄數 | 2 | |
| totalPage | Integer | 總頁數 | 1 | |
| currentCount | Integer | 當前記錄數 | 2 |
表 customItem
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| regionID | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| customItemID | String | 自定義監控項ID | ITEM793d5923652be6ce202306291409 | |
| name | String | 監控項名稱 | 我的CPU使用率 | |
| unit | String | 自定義監控項的單位 | % | |
| interval | Integer | 數據上報間隔，單位秒 | 60 | |
| dimensions | Array of Strings | 用于查詢監控數據的維度 | ['uuid','usage'] | dimension |
表 dimension
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| name | String | 維度名稱，支持英文、下劃線 | uuid | |
| description | String | 維度描述，支持中文、英文、下劃線 | 主機的唯一標識 |
請求示例
請求url
/v4/monitor/query-custom-items?regionID=81f7728662dd11ec810800155d307d5b&name=CPU使用率&pageNo=1&pageSize=10
請求頭header
無
請求體body
無
響應示例
{
"statusCode": 800,
"errorCode":"",
"message": "Success",
"msgDesc": "成功",
"returnObj": {
"customItemList": [
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"customItemID": "ITEM793d5923652be6ce202306291409",
"name": "我的CPU使用率",
"unit": "%",
"interval": 60,
"dimensions": [
{
"name": "uuid",
"description": "主機的唯一標識"
},
{
"name": "usage",
"description": "主機用途"
}
]
},
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"customItemID": "ITEM233d5923652be6ce202306291409",
"name": "新的CPU使用率",
"unit": "%",
"interval": 300,
"dimensions": [
{
"name": "uuid",
"description": "主機的唯一標識"
},
{
"name": "host",
"description": "主機所在宿主機"
}
]
}
],
"totalCount": 2,
"totalPage": 1,
"currentCount": 2
}
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |
