接口功能介绍
调用此接口可查看探测节点的配置详情。
接口约束
资源池ID，探测节点名称不能为空。
URI
GET /v4/monitor/describe-probe-point
请求参数
Query参数
| 参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 资源池ID | |
| name | String | 是 | NeiMeng | 探测节点名称 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| mongoID | String | 数据库ID | 635a4a3869bdc841ab0495dd | |
| ID | String | 探测节点唯一ID | 1 | |
| name | String | 探测节点名称 | NeiMeng | |
| hermesRegion | String | region名称 | neimengaz_03 | |
| position | String | 探测节点区域 | 内蒙 | |
| status | Boolean | 探测节点是否可用 | true |
请求示例
GET /v4/monitor/describe-site-monitor?regionID=81f7728662dd11ec810800155d307d5b&name=NeiMeng
响应示例
{
"statusCode":800,
"returnObj":{
"mongoID":"635a4a3869bdc841ab0495dd",
"ID":"1",
"name":"NeiMeng",
"hermesRegion":"neimengaz_03",
"position":"内蒙",
"status":true
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.SiteMonitor.ProbePointNotAvailable | 探测点不可用 |
| 其他 | 参见公共错误码说明 |
