自定義監控項：查詢維度值
更新時間 2024-09-25 16:20:51
最近更新時間: 2024-09-25 16:20:51
分享文章
自定義監控項
自定義監控項：查詢維度值
接口功能介紹
調用此接口可查詢指定自定義監控項的維度值。
接口約束
資源池ID，自定義監控項ID不能為空。
URI
POST /v4/monitor/query-custom-item/dimension-values
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| customItemID | 是 | String | 自定義監控項ID | ITEM793d5923652be6ce202306291409 | |
| filter | 否 | Array of Objects | 要過濾的維度條件 | filterDimension | |
| dimensionName | 是 | String | 待查詢的維度值 | usage |
表 filterDimension
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| name | 是 | String | 維度名稱 | uuid | |
| value | 是 | Array of Strings | 維度對應值 | ['c0d6a468-7f93-f637-6668-591894339d59','b0d6a468-7f93-f637-6668-591894339d56'] |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回參數，參考returnObj對象結構 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| dimensionValueList | Array of Strings | 查詢得到的維度值 | ['compute'] |
請求示例
請求url
/v4/monitor/query-custom-item/dimension-values
請求頭header
無
請求體body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"customItemID": "64ea1664-4347-558e-9bc6-651341c2fa15",
"filter": [
{
"name": "uuid",
"value": [
"c0d6a468-7f93-f637-6668-591894339d59",
"b0d6a468-7f93-f637-6668-591894339d56"
]
}
],
"dimensionName": "usage"
}
響應示例
{
"statusCode": 800,
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"returnObj": {
"dimensionValueList": [
"compute"
]
}
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.CustomItem.DimensionNotFound | 維度不存在 |
| Monitor.CustomItem.ItemIDNotFound | 監控項ID不存在 |
| 其他 | 參見公共錯誤碼說明 |
