接口功能介绍
为监控视图新增监控项,原有监控项保留。
如果新增监控项与原有监控项key相同,则以新增监控项值为准。
一个监控视图包含一个或多个监控项,监控项为key-value格式。
接口约束
regionID(资源池)、templateID(监控面板)、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 | 监控视图不存在 |
其他 | 参见公共错误码说明 |