监控面板：视图监控项校验
更新时间 2023-07-19 11:41:03
最近更新时间: 2023-07-19 11:41:03
接口功能介绍
一个监控视图包含一个或多个监控项，监控项为key-value格式。
校验指定监控视图中的监控项 Key 是否存在。
接口约束
regionID（资源池）、templateID（监控面板）、viewID（监控视图）存在。
URI
GET /v4/monitor/check-monitor-item
请求参数
Query参数
| 参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 资源池ID | |
| templateID | String | 是 | 466d5eb4-4843-11ed-a9b7-005056897257 | 监控面板ID | |
| viewID | String | 是 | 4cb790ae-4894-11ed-b386-005056897257 | 监控视图ID | |
| itemKey | String | 是 | key1 | 监控项Key |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 返回对象 | returnObj |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| exist | Boolean | 是否存在给定监控项Key | true |
请求示例
GET /v4/monitor/describe-monitor-view?regionID=81f7728662dd11ec810800155d307d5b&templateID=466d5eb4-4843-11ed-a9b7-005056897257&viewID=4cb790ae-4894-11ed-b386-005056897257&itemKey=key1
响应示例
{
"statusCode": 800,
"returnObj": {
"exist": true
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.Template.NotExist | 监控面板不存在 |
| Monitor.TemplateView.NotExist | 监控视图不存在 |
| 其他 | 参见公共错误码说明 |
