接口功能介绍
更新监控面板（更新监控面板名称或为监控面板增加一个监控视图）
本接口有两个功能：
- 更新监控面板的名称；
- 在指定的监控面板中，添加一个监控视图。
一个监控面板可以包含多个监控视图，一个监控视图可以包含多个监控项。
如果name（监控面板名称），templateTitle（监控视图名称），templateContent（监控项内容）都被传入，则默认更新监控面板名称。
接口约束
regionID和templateID存在。
当更新监控面板名称时，参数name必传；
当在指定监控面板添加一个监控视图时，参数name必不传，而参数templateTitle和templateContent必传。
URI
POST /v4/monitor/put-monitor
请求参数
请求体body参数
| 参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 资源池ID | |
| templateID | String | 是 | 2ad61e2e-5046-11ed-8fb7-005056897257 | 监控面板ID | |
| name | String | 否 | newName | 新的监控面板名称 | |
| templateTitle | String | 否 | testNewTitle | 监控视图名称 | |
| templateContent | Object | 否 | 监控项具体内容，为key-value格式 | templateContent |
表templateContent
| 参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
|---|---|---|---|---|---|
| {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
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| templateID | String | 操作的监控面板ID | 2ad61e2e-5046-11ed-8fb7-005056897257 |
请求示例
POST /v4/monitor/put-monitor
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"templateID": "2ad61e2e-5046-11ed-8fb7-005056897257",
"templateTitle": "testNewTitle",
"templateContent": {
"tcKey11": "tcVal11",
"tcKey22": "tcVal22"
}
}
响应示例
{
"statusCode": 800,
"returnObj": {
"templateID": "2ad61e2e-5046-11ed-8fb7-005056897257"
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.Template.NameNoChange | 监控面板名称与旧名称相同 |
| 其他 | 参见公共错误码说明 |
