接口功能介绍
检查是否存在给定名称的监控面板。
这里的名称,是指监控面板自身的名称。
接口约束
regionID(资源池)存在。
URI
GET /v4/monitor/check-monitor-name
请求参数
Query参数
参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
---|---|---|---|---|---|
regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 资源池ID | |
name | String | 是 | template_name_exist_test | 要检查的监控面板名称 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败),默认值:800 | 800 | |
errorCode | String | 失败时的错误代码,参见公共错误码说明 | ||
message | String | 失败时的错误描述,一般为英文描述 | Success | |
msgDesc | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 返回对象 | returnObj |
表returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
exist | Boolean | 是否存在给定名称的监控面板 | true |
请求示例
GET /v4/monitor/check-monitor-name?regionID=81f7728662dd11ec810800155d307d5b&name=template_name_exist_test
响应示例
{
"statusCode": 800,
"returnObj": {
"exist": true
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
状态码
状态码 | 描述 |
---|---|
200 | 请求成功 |
错误码
errorCode | 描述 |
---|---|
其他 | 参见公共错误码说明 |