监控看板
监控看板：重命名
接口功能介绍
重命名监控看板。
接口约束
参见请求参数说明。
URI
POST /v4/monitor/monitor-board/rename
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| boardID | 是 | String | 监控看板ID | 58631437-d489-7105-d9ac-9bc044d7b6ab | |
| name | 是 | String | 新监控面板名称，不可重复 | newname |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，适配中英文 | 成功 | |
| description | String | 失败时的错误描述，适配中英文 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| success | Boolean | 是否成功 | true |
请求示例
请求url
/v4/monitor/monitor-board/rename
请求头header
无
请求体body
{
"regionID": "1234567890",
"boardID": "5b05c1d8-c7ad-4296-296d-2c415c1b1791",
"name": "newName"
}
响应示例
{
"statusCode": 800,
"returnObj": {
"success": true
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.MonitorBoard.NotExist | 监控看板不存在 |
| Monitor.MonitorBoard.NameAlreadyExist | 监控看板名称已存在 |
| 其他 | 参见公共错误码说明 |
