自定義監控項：創建
更新時間 2024-09-25 16:20:51
最近更新時間: 2024-09-25 16:20:51
分享文章
自定義監控項
自定義監控項：創建
接口功能介紹
調用此接口可創建自定義監控項。
接口約束
資源池ID，監控項名稱，單位，上報頻率不能為空。
URI
POST /v4/monitor/create-custom-item
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| name | 是 | String | 監控項名稱，必須4-20個字符，支持中英文、數字、下劃線，且不能以數字開頭。同一用戶在同一資源池下不能重復 | 我的CPU使用率 | |
| unit | 是 | String | 自定義監控項的單位 | % | |
| interval | 是 | Integer | 數據上報間隔，單位秒 | 60 | |
| dimensions | 否 | Array of Objects | 用于查詢監控數據的維度，目前最多支持三個維度 | dimensions |
表 dimensions
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| name | 是 | String | uuid | 維度名稱，支持英文、下劃線 | |
| description | 否 | String | 主機的唯一標識 | 維度描述，支持中文、英文、下劃線 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回參數，參考returnObj對象結構 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| customItemID | String | 自定義監控項ID | ITEM793d5923652be6ce202306291409 |
請求示例
請求url
/v4/monitor/create-custom-item
請求頭header
無
請求體body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"name": "我的CPU使用率",
"unit": "%",
"interval": 60,
"dimensions": [
{
"name": "uuid",
"description": "主機的唯一標識"
},
{
"name": "usage",
"description": "主機用途"
}
]
}
響應示例
{
"statusCode":800,
"returnObj":{
"customItemID":"ITEM793d5923652be6ce202306291409"
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.CustomItem.NameAlreadyExist | 監控項名稱已存在，不能重復 |
| 其他 | 參見公共錯誤碼說明 |
