站点监控
站点监控任务：查询
接口功能介绍
调用此接口可查询站点监控任务。
接口约束
无
URI
GET /v4/monitor/query-site-monitor
路径参数
无
Query 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| protocol | 否 | String | 本参数表示探测类型。取值范围：http：http 探测。ping：ping 探测。tcp：tcp 探测。udp：udp 探测。根据以上范围取值。 | http | |
| taskName | 否 | String | 站点监控任务名称，支持中英文 | siteMonitor1-修改 | |
| taskID | 否 | String | 站点监控任务 ID | 64ea1664-4347-558e-9bc6-651341c2fa15 | |
| search | 否 | String | 对站点地址（address）进行模糊搜索 | baidu | |
| pageNo | 否 | Integer | 页码，默认为 1 | 1 | |
| pageSize | 否 | Integer | 页大小，默认为 10 | 1 | |
| sort | 否 | String | 本参数表示排序字段。取值范围：avgAvailability：可用率。avgResponseTime：平均响应时间。根据以上范围取值。 | avgResponseTime | |
| asc | 否 | Integer | 本参数表示排序字段。取值范围：0：倒序。1：正序。根据以上范围取值。 | 1 |
请求参数
请求头 header 参数
无
请求体 body 参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800 为成功，900 为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回参数 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| taskList | Array of Objects | 站点监控任务列表 | task | |
| totalCount | Integer | 总记录数 | 2 | |
| totalPage | Integer | 总页数 | 1 | |
| currentCount | Integer | 当前页记录数 | 2 |
表 task
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| taskID | String | 站点监控任务 ID | 64ea1664-4347-558e-9bc6-651341c2fa15 | |
| taskName | String | 站点监控任务名称 | siteMonitor1-修改 | |
| protocol | String | 本参数表示探测类型。取值范围：http：http 探测。ping：ping 探测。tcp：tcp 探测。udp：udp 探测。根据以上范围取值。 | http | |
| address | String | 站点地址 | http://www.baidu.com | |
| evalInterval | Integer | 本参数表示探测间隔，单位秒。取值范围：60：60s。300：300s。1200：1200s。1800：1800s。根据以上范围取值。 | 60 | |
| probePoint | Array of Strings | 探测点 | ['East_China','North_China'] | |
| lastChange | String | 最近更新时间 | 2022-11-09T08:13:09Z | |
| status | Boolean | 状态 | true | |
| avgAvailability | String | 可用率，单位% | 49.58 | |
| avgResponseTime | String | 平均响应时间，单位毫秒 | 185.40 |
请求示例
请求 url
/v4/monitor/query-site-monitor?pageNo=1&pageSize=5
请求头 header
无
请求体 body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"taskList": [
{
"taskID": "2ff8065f-59d1-473d-84c4-5f6abf4742f2",
"taskName": "ping测试",
"protocol": "ping",
"address": "55.242.30.32",
"evalInterval": 60,
"probePoint": ["1", "2"],
"status": true,
"lastChange": "2023-11-28 15:27:14",
"avgAvailability": "100.00",
"avgResponseTime": "0.00"
},
{
"taskID": "fdad7b78-9d90-4321-a8c5-f3f3495edcb5",
"taskName": "http测试",
"protocol": "http",
"address": "http://www.baidu.com",
"evalInterval": 60,
"probePoint": ["1", "2"],
"status": true,
"lastChange": "2023-11-28 15:18:39",
"avgAvailability": "50.00",
"avgResponseTime": "62.00"
}
],
"totalCount": 2,
"totalPage": 1,
"currentCount": 2
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.SiteMonitor.SitemMonitorIDNotFound | 站点 ID 不存在 |
| 其他 | 参见公共错误码说明 |
