站点监控任务:创建
更新时间 2026-06-09 10:53:41
最近更新时间: 2026-06-09 10:53:41
接口功能介绍
调用此接口可创建站点监控任务。
接口约束
站点监控任务名称,探测类型,站点地址,探测间隔,探测点列表不为空,且探测节点应可用。
URI
POST /v4/monitor/create-site-monitor
路径参数 无
Query参数 无
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| taskName | 是 | String | 站点监控任务名称,支持中英文 | siteMonitor1-示例 | |
| protocol | 是 | String | 本参数表示探测类型。取值范围: http:http探测。 ping:ping探测。 tcp:tcp探测。 udp:udp探测。 pagehttp:浏览器探测。 根据以上范围取值。 | http | |
| address | 是 | String | 站点地址。 ping示例:www.ctyun.cn tcp/udp示例:www.ctyun.cn:80 http示例:http://www.ctyun.cn或https://www.ctyun.cn | http://www.ctyun.cn | |
| evalInterval | 是 | Integer | 探测间隔,单位秒 | 60 | |
| probePoint | 是 | Array of Strings | 探测节点列表,如['East_China','North_China'],可用探测节点可通过探测节点:查询列表接口获取 | ||
| options | 否 | Object | options |
表 options
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| httpMethod | 否 | String | |||
| headers | 否 | String | |||
| cookies | 否 | String | |||
| redirectLimit | 否 | Integer | |||
| verifySkip | 否 | Boolean | |||
| authUser | 否 | String | |||
| authPwd | 否 | String | |||
| bodyContent | 否 | String | |||
| dnsServer | 否 | String | |||
| dnsHijackWhiteList | 否 | String | |||
| responseAssertions | 否 | Array of Objects | responseAssertions | ||
| startTime | 否 | String | |||
| endTime | 否 | String | |||
| weekdays | 否 | Array of Integers | |||
| timeout | 否 | Integer | |||
| deviceType | 否 | String | |||
| browserType | 否 | String | |||
| autoScrolling | 否 | Boolean |
表 responseAssertions
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| assertionType | 否 | String | |||
| jsonPath | 否 | String | |||
| operator | 否 | String | |||
| value | 否 | String |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功,900为失败),默认值:800 | 800 | |
| errorCode | String | 失败时的错误代码,参见公共错误码说明 | ||
| message | String | 失败时的错误描述,一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述,一般为中文描述 | 成功 | |
| returnObj | Object | 返回参数,参考returnObj对象结构 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| siteID | String | 站点监控任务ID | 64ea1664-4347-558e-9bc6-651341c2fa15 |
枚举参数
无
请求示例
请求url
/v4/monitor/create-site-monitor
请求头header
无
请求体body
{
"name": "siteMonitor1-示例",
"protocol": "http",
"address": "http: //www.ctyun.cn",
"evalInterval": 60,
"probePoint": [
"NeiMeng"
]
}
响应示例
{
"statusCode": 800,
"returnObj": {
"siteID": "64ea1664-4347-558e-9bc6-651341c2fa15"
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
状态码
请参考 状态码
错误码
请参考 错误码