監控面板：視圖監控項創建
更新時間(jian) 2023-07-19 11:41:02
最近更新(xin)時間: 2023-07-19 11:41:02
分享文(wen)章
接口功能介紹
為監控視圖新增監控項，原有監控項保留。
如果新增監控項與原有監控項key相同，則以新增監控項值為準。
一個監控(kong)視圖(tu)包含一個或多(duo)個監控(kong)項,監控(kong)項為key-value格式。
接口約束
regionID（資(zi)源池）、templateID（監控面板(ban)）、viewID（監控視圖）存在。
URI
POST /v4/monitor/create-monitor-item
請求參數
請求體body參數
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 資源池ID | |
| templateID | String | 是 | 466d5eb4-4843-11ed-a9b7-005056897257 | 監控面板ID | |
| viewID | String | 是 | f750ec8a-487c-11ed-a9b7-005056897257 | 監控視圖ID | |
| itemContent | Object | 是 | 要添加的監控項內容，為key-value格式 | itemContent |
表itemContent
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| {itemName} | String | 是 | tcKey11 | 監控項名稱 | |
| {value} | Object | 是 | tcVal11 | 監控項值，與監控項名稱組成key-value格式，可以為任意內容 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| returnObj | Object | 返回對象 | returnObj |
表returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| success | Boolean | 是否創建成功 | true |
請求示例
POST /v4/monitor/create-monitor-item
請求體body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"templateID": "466d5eb4-4843-11ed-a9b7-005056897257",
"viewID": "0d0aa860-4894-11ed-b386-005056897257",
"itemContent": {
"newKey1": "newVal1",
"newKey2": "newVal2"
}
}
響應示例
{
"statusCode": 800,
"returnObj": {
"success": true
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.Template.NotExist | 監控面板不存在 |
| Monitor.TemplateView.NotExist | 監控視圖不存在 |
| 其他 | 參見公共錯誤碼說明 |
