接口功能介绍
删除监控视图中的指定监控项。
一个监控视图包含一个或多个监控项,监控项内容为key-value格式。
不能删除该视图下的所有监控项,必须保证有实际的监控项内容,否则请使用监控视图删除。
接口约束
regionID(资源池)、templateID(监控面板)、viewID(监控视图)、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 | 删除监控项后监控视图将为空 |
其他 | 参见公共错误码说明 |