CreateSiteMonitor
创建站点监控任务
服务地址:
华东1(杭州)
输入参数
只看必填
Address监控任务的URL或IP地址
TaskType监控任务的监控类型
TaskName监控任务的名称
Interval监控频率
IspCities探针信息
OptionsJson监控任务对应协议类型的高级扩展选项
AlertIds报警规则ID
CustomSchedule自定义探测周期
VpcConfig创建vpc内网拨测任务时需要提供的网络信息
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

本文将提供一个示例,创建一个站点监控任务HanZhou_ECS1,该监控任务的监控地址为https://www.aliyun.com、监控类型为HTTPS

请求参数

字段名称字段详情
Addressstring

监控任务的 URL 或 IP 地址。

示例值:https://www.aliyun.com
TaskTypestring

监控任务的监控类型。展开详情

示例值:HTTP
TaskNamestring

监控任务的名称。展开详情

示例值:HanZhou_ECS1
Intervalstring

监控频率。展开详情

示例值:1
IspCitiesstring

探针信息。如果该参数取值为空,则系统随机选择 3 个探测点。展开详情

示例值:[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]
OptionsJsonstring

监控任务对应协议类型的高级扩展选项。不同监控任务的协议类型对应不同的扩展选项。

示例值:{"time_out":5000}
AlertIdsstring

报警规则 ID。展开详情

示例值:SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent
CustomSchedulestring

自定义探测周期。只能选择周一至周日的某个时间段进行探测。

示例值:{"start_hour":0,"end_hour":24, "days":[0], "time_zone":"Local"}
VpcConfigstring

创建 vpc 内网拨测任务时需要提供的网络信息。需要提供一个 JSON,里边必须包含 vpcId,vswitchId,securityGroupId 和 region 四个字段。

示例值:{"vpcId": "vpc-xxxxxx", "vswitchId": "vsw-xxxxxx", "securityGroupId": "sg-xxxxxx", "region": "cn-beijing"}

请求说明

TaskType 中 HTTP(S)、PING、TCP、UDP、DNS、WEBSOCKET、SMTP、POP3 和 FTP 的高级参数的设置方法如下表所示。

  • HTTP(S)
参数类型描述
http_methodStringHTTP 或 HTTPS 请求方式。支持三种请求方式:GET、POST、HEAD。默认值:GET。
headerString换行符(\n)分隔的自定义 HTTP header。
每行 Header 格式需符合 HTTP 协议(使用半角冒号分隔的键值)。
cookieStringCookie 和 HTTP 请求标准的写法一致。
request_contentString请求内容。支持两种格式:JSON 和表单。不提供时,请求中不含正文。
response_contentString期望的回应内容。探测时会在 HTTP 服务器返回的前 64 个字节进行检查。
match_ruleString0:回应中不含 response_content 时,探测成功。
1:回应中含 response_content 时,探测成功。
usernameString如果提供用户名,则会在 HTTP 请求中携带 BasicAuth header。
passwordStringHTTP 或 HTTPS 请求验证密码。
time_outint超时时间。单位:毫秒。默认值:5 。
max_redirectint最大跳转次数。ECS 探针默认 5 次,运营商探针默认 2 次。
如果需要禁止跳转,则将该参数设置为:0。
取值范围:0~50 。
  • PING
参数类型描述
failure_rate文本当 PING 失败率超过该参数时,探测失败,返回 610(PingAllFail)或 615(PingPartialFail)。
默认值:0.1。
ping_numintPING 次数,默认值:10。
取值范围:1~100。
  • DNS
参数类型描述
dns_serverstringDNS 服务器地址,可以为域名或 IP 地址。
dns_typestringDNS 查询类型。取值:A、NS、CNAME、MX、TXT、ANY、AAAA。
expect_valuestring英文空白符分隔的期望值列表。
match_rulestring期望值列表与 DNS 列表的关系,当不满足指定关系时,探测失败。
空字符串或 IN_DNS:期望值列表是 DNS 列表的子集。
DNS_IN:DNS 列表是期望值列表的子集。
EQUAL:DNS 列表与期望值列表相等。
ANY:DNS 列表与期望值列表有交集(交集不为空)。
  • FTP
参数类型描述
portintFTP 服务器端口号。如果不提供,则使用默认值。FTP 默认值:21,FTPS 默认值:990。
usernamestringFTP 用户名。 如果未提供,则匿名登录。
passwordstringFTP 密码。
  • POP3 或 SMTP
参数类型描述
portintPOP3 或 SMTP 服务器的端口号。POP3 默认值:110,POP3S 默认值:995,SMTP 默认值:25。
usernamestringPOP3 或 SMTP 的用户名。POP3 或 SMTP 的用户名和密码必填。
passwordstringPOP3 或 SMTP 的密码。POP3 或 SMTP 的用户名和密码必填。
  • TCP 或 UDP
参数类型描述
portintTCP 或 UDP 服务器的端口。
request_contentstring请求内容。当 request_format 为 hex 时,request_content 内容为十六进制紧凑格式。
request_formatstring当 request_format 为其他值时,request_content 作为普通字符串发送给 TCP 或 UDP 服务器。
response_contentstring回应内容。当 TCP 或 UDP 服务器返回的内容中不含 response_content 时,探测失败。
当 response_format 为 hex 时,response_content 中的内容为十六进制紧凑格式。
当 response_content 为其他值时,response_content 为普通字符串。
  • WEBSOCKET
参数类型描述
request_contentstring消息内容。
empty_messageboolean允许服务端不返回消息或返回空字符串。

返回参数

字段名称字段详情
Codestring

状态码。展开详情

示例值:200
Messagestring

返回信息。

示例值:Successful
RequestIdstring

请求 ID。

示例值:68192f5d-0d45-4b98-9724-892813f86c71
Successstring

操作是否成功。取值:展开详情

示例值:true
Dataobject

监控任务的结果详情。

CreateResultListobject
变更历史
暂无变更历史