監控面板：視圖監控項刪除
更(geng)新時間 2023-07-19 11:41:02
最近(jin)更(geng)新時間(jian): 2023-07-19 11:41:02
分享文章(zhang)
接口功能介紹
刪除監控視圖中的指定監控項。
一個監控視圖包含一個或多個監控項，監控項內容為key-value格式。
不能刪(shan)除(chu)(chu)該(gai)視(shi)圖下的所(suo)有(you)監控項(xiang)，必須保(bao)證有(you)實際(ji)的監控項(xiang)內容，否則請使用監控視(shi)圖刪(shan)除(chu)(chu)。
接口約束
regionID（資源池）、templateID（監控面板）、viewID（監控視(shi)圖）、itemKeys（監控項Key）存在。
URI
POST /v4/monitor/delete-monitor-item
請求參數
請求體body參數
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 資源池ID | |
| templateID | String | 是 | 466d5eb4-4843-11ed-a9b7-005056897257 | 監控面板ID | |
| viewID | String | 是 | 4cb790ae-4894-11ed-b386-005056897257 | 監控視圖ID | |
| itemKeys | Array of String | 是 | ["tcKey1"] | 要刪除的監控項內容Key |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，一般為中文描述 | 成功 | |
| returnObj | Object | 返回對象 | returnObj |
表returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| deleteCount | Integer | 刪除成功的監控項數目 | 1 |
請求示例
POST /v4/monitor/delete-monitor-item
請求體body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"templateID": "466d5eb4-4843-11ed-a9b7-005056897257",
"viewID": "4cb790ae-4894-11ed-b386-005056897257",
"itemKeys": [
"tcKey1"
]
}
響應示例
{
"statusCode": 800,
"returnObj": {
"deleteCount": 1
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.Template.NotExist | 監控面板不存在 |
| Monitor.TemplateView.NotExist | 監控視圖不存在 |
| Monitor.TemplateItem.NotExist | 監控項不存在 |
| Monitor.TemplateView.WillEmpty | 刪除監控項后監控視圖將為空 |
| 其他 | 參見公共錯誤碼說明 |
