站点监控
站点监控任务：创建
接口功能介绍
调用此接口可创建站点监控任务。
接口约束
站点监控任务名称，探测类型，站点地址，探测间隔，探测点ID列表不为空，且探测节点应可用。
URI
POST /v4/monitor/create-site-monitor
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| taskName | 是 | String | 站点监控任务名称，支持中英文 | siteMonitor1-示例 | |
| protocol | 是 | String | 本参数表示探测类型。取值范围：http：http探测。ping：ping探测。tcp：tcp探测。udp：udp探测。根据以上范围取值。 | http | |
| address | 是 | String | 站点地址。ping示例：www.baidu.comtcp/udp示例：www.baidu.com:80http示例：http://www.baidu.com或https://www.baidu.com | http://www.baidu.com | |
| evalInterval | 是 | Integer | 本参数表示探测间隔，单位秒。取值范围：60：60s。300：300s。1200：1200s。1800：1800s。根据以上范围取值。 | 60 | |
| probePoint | 是 | Array of Strings | 探测节点ID列表，如['1','2']，可用探测节点ID可通过探测节点：查询列表接口获取 | ['1'] |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回参数，参考returnObj对象结构 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| taskID | String | 站点监控任务ID | 64ea1664-4347-558e-9bc6-651341c2fa15 |
请求示例
请求url
/v4/monitor/create-site-monitor
请求头header
无
请求体body
{
"taskName":"siteMonitor1-示例",
"protocol":"http",
"address":"http://www.baidu.com",
"evalInterval":60,
"probePoint":[
"1"
]
}
响应示例
{
"statusCode":800,
"returnObj":{
"taskID":"64ea1664-4347-558e-9bc6-651341c2fa15"
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.SiteMonitor.ProbePointNotAvailable | 探测点不可用 |
| 其他 | 参见公共错误码说明 |
