接口功能介绍
调用此接口可修改站点监控任务。
接口约束
资源池ID,站点监控任务ID,站点监控任务名称,探测类型,站点地址,探测间隔,探测点列表不为空,且探测节点应可用。
URI
POST /v4/monitor/modify-site-monitor
请求参数
请求体body参数
参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
---|---|---|---|---|---|
regonID | String | 是 | 81f7728662dd11ec810800155d307d5b | 资源池ID | |
siteID | String | 是 | 64ea1664-4347-558e-9bc6-651341c2fa15 | 站点监控任务ID | |
name | String | 是 | siteMonitor1-修改 | 站点监控任务名称,支持中英文 | |
protocol | String | 是 | http | 本参数表示探测类型。取值范围:http:http探测。ping:ping探测。tcp:tcp探测。udp:udp探测。根据以上范围取值。 | |
address | String | 是 | http://www.baidu.com | 站点地址。ping示例:www.baidu.comtcp/udp示例:www.baidu.com:80http示例:http://www.baidu.com或https://www.baidu.com | |
evalInterval | Integer | 是 | 60 | 探测间隔,单位秒 | |
probePoint | Array of String | 是 | ["NeiMeng"] | 探测节点列表,如["East_China","North_China"],可用探测节点可通过探测节点:查询列表接口获取 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
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 |
请求示例
POST /v4/monitor/modify-site-monitor
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"siteID":"64ea1664-4347-558e-9bc6-651341c2fa15",
"name":"siteMonitor1-修改",
"protocol":"http",
"address":"http://www.baidu.com",
"evalInterval":60,
"probePoint":[
"NeiMeng"
]
}
响应示例
{
"statusCode":800,
"returnObj":{
"siteID":"64ea1664-4347-558e-9bc6-651341c2fa15"
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
状态码 | 描述 |
---|---|
200 | 请求成功 |
错误码
errorCode | 描述 |
---|---|
Monitor.SiteMonitor.SitemMonitorIDNotFound | 站点ID不存在 |
Monitor.SiteMonitor.ProbePointNotAvailable | 探测点不可用 |
其他 | 参见公共错误码说明 |