接口功能介绍
调用此接口可查询站点监控任务。
接口约束
资源池ID不能为空。
URI
GET /v4/monitor/query-site-monitor
请求参数
Query参数
| 参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 资源池ID | |
| siteID | String | 否 | 64ea1664-4347-558e-9bc6-651341c2fa15 | 站点监控任务ID | |
| protocol | String | 否 | http | 探测类型 可取值 http ping tcp udp | |
| name | String | 否 | siteMonitor1-修改 | 站点监控任务名称，支持中英文 | |
| search | String | 否 | baidu | 对站点地址（address）进行模糊搜索 | |
| pageNo | Integer | 否 | 1 | 页码，默认为1 | |
| page | Integer | 否 | 1 | 页码，默认为1，建议使用pageNo，该参数后续会下线 | |
| pageSize | Integer | 否 | 1 | 页大小，默认为10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| siteList | Array of Objects | 站点监控任务列表 | site | |
| totalCount | Integer | 总记录数 | 2 | |
| totalPage | Integer | 总页数 | 1 | |
| currentCount | Integer | 当前页记录数 | 2 | |
| page | Integer | 页码，建议参考请求参数pageNo，该参数后续会下线 | 1 | |
| pageSize | Integer | 页大小，建议参考请求参数pageSize，该参数后续会下线 | 10 |
表site
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| regionID | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| siteID | String | 站点监控任务ID | 64ea1664-4347-558e-9bc6-651341c2fa15 | |
| monitorID | String | 站点监控任务ID（底层） | dkql20221109161309 | |
| name | String | 站点监控任务名称 | siteMonitor1-修改 | |
| protocol | String | 探测类型 | http | |
| address | String | 站点地址 | http://www.baidu.com | |
| evalInterval | Integer | 探测间隔，单位：秒 | 60 | |
| probePoint | Array of String | 探测点 | ["East_China","North_China"] | |
| lastChange | String | 最近更新时间 | 2022-11-09T08:13:09Z | |
| status | Boolean | 状态 | true |
请求示例
GET /v4/monitor/query-site-monitor?regionID=81f7728662dd11ec810800155d307d5b&page=1&pageSize=5
响应示例
{
"statusCode":800,
"returnObj":{
"siteList":[
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"siteID":"64ea1664-4347-558e-9bc6-651341c2fa15",
"monitorID":"dkql20221109161309",
"name":"siteMonitor1-修改",
"protocol":"http",
"address":"http://www.baidu.com",
"evalInterval":60,
"probePoint":[
"NeiMeng"
],
"lastChange":"2022-11-09T08:13:09Z",
"status":true
},
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"siteID":"f1aa04c0-7d93-5d2c-bf9d-3b25623d69c4",
"monitorID":"jaeg20221109161534",
"name":"siteMonitor4-示例",
"protocol":"ping",
"address":"www.baidu.com",
"evalInterval":60,
"probePoint":[
"NeiMeng"
],
"lastChange":"2022-11-09T08:15:34Z",
"status":true
},
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"siteID":"64ea1664-4347-558e-9bc6-651341c2fa15",
"monitorID":"fxfm20221109165039",
"name":"siteMonitor4-示例",
"protocol":"ping",
"address":"www.baidu.com",
"evalInterval":60,
"probePoint":[
"NeiMeng"
],
"lastChange":"2022-11-09T08:50:39Z",
"status":true
}
],
"totalCount":3,
"totalPage":1,
"currentCount":3,
"page":1,
"pageSize":5
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.SiteMonitor.SitemMonitorIDNotFound | 站点ID不存在 |
| 其他 | 参见公共错误码说明 |
