CreateSiteMonitor_站点监控_API参考

站点监控支持 HTTP 、PING 、TCP 、UDP 、DNS 、SMTP 、POP3 、FTP 8种类型的探测任务，不同的类型对应不同的扩展参数(OptionsJson)，扩展参数说明详见如下列表。

HTTP


参数名	类型	描述
http_method	String	HTTP请求方式，支持三种：GET、POST、HEAD。缺省值为GET。
header	String	换行符("\n")分隔的用户自定义HTTP header。每行header格式需符合http协议要求（英文冒号分隔的键值）。
cookie	String	cookie，和HTTP请求标准的写法一致。
request_content	String	请求内容。支持两种格式：json和表单，不提供时，请求中不含正文。
response_content	String	期望的回应内容。探测时会在HTTP服务器返回的前64K字节进行检查。
match_rule	String	0 - 回应中不含response_content时，探测成功， 1 - 回应中含response_content时，探测成功。
username	String	如果提供username，则会在http请求中携带BasicAuth header 。
password	String	HTTP请求验证密码。
time_out	int	超时时间，单位：毫秒。缺省：5秒。
max_redirect	int	大跳转次数。ECS探针缺省5次，运营商探针缺省2次。如果需要禁止跳转，则将该值置为：0。取值范围：[0, 50] 。

PING


参数名	类型	描述
failure_rate	int	当PING失败率超过该值时。则探测失败。返回610(PingAllFail)，或615(PingPartialFail)。缺省：0.1。
ping_num	int	PING次数，缺省：20。取值范围：[1, 100]。

DNS


参数名	类型	描述
dns_server	string	DNS服务器地址，可以为域名或IP地址。
dns_type	string	DNS查询类型，可取值：A、NS、CNAME、MX、TXT、ANY。
expect_value	string	英文空白符(参见下表)分隔的期望值列表。
match_rule	string	期望值列表与dns列表的关系，当不满足指定关系时，探测失败。空字符串或IN_DNS: 期望值列表是dns列表的子集。 DNS_IN: dns列表是期望值列表的子集。 EQUAL: dns列表与期望值列表相等。 ANY: dns列表与期望值列表有交集(交集不为空) 。

FTP


参数名	类型	描述
port	int	FTP服务器端口号。如果不提供，则使用缺省：ftp: 21, ftps: 990。
username	string	用户名、密码。如果未提供则匿名登录。用户名：anonymous 密码：ftp@example.com 。
password	string	FTP密码。

POP3/SMTP


参数名	类型	描述
port	int	POP3服务器端口号。缺省, pop3:110, pop3s:995。
username	string	用户名。
password	string	密码。

TCP/UDP


参数名	类型	描述
port	int	探测的TCP/UDP端口。
request_content	string	请求的内容。当request_format为"hex"时，request_content的内容为十六进制紧凑格式。
request_format	string	当request_format为其它值时，request_content作为普通字符串发送给服务器。
response_content	string	回应内容。当服务器返回的内容中不含response_content时，探测失败。当response_format为"hex"时，response_content中的内容为十六进制紧凑格式。当response_content为其它值时，response_content为普通字符串。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Address	String	是	http://www.aliyun.com	任务的探测URL地址或IP地址。
TaskName	String	是	网站探测	监控的任务名为4-100位长度的中英文字符数字、下划线以及汉字。
TaskType	String	是	HTTP	任务的类型，目前站点监控探测的有：HTTP 、PING 、TCP 、UDP 、DNS 、SMTP 、POP3 、FTP。
Action	String	否	CreateSiteMonitor	系统规定参数。取值：CreateSiteMonitor。
AlertIds	String	否	49f7c317-7645-4cc9-94fd-ea42e122****	关联已存在的报警规则ID。
Interval	String	否	1	探测频率，单位为分钟，取值范围1、5、15，单位是分钟，默认值为1分钟。
IspCities	String	否	[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]	探针的信息，格式为jsonArray，例如`[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]`（分别对应北京、杭州、青岛) 可以使用 DescribeISPAreaCity 接口获取探测点信息。如果为空系统则随机选择3个探点探测。
OptionsJson	String	否	{"time_out":5000}	监控对应协议的高级扩展选项，不同的探测协议类型对应不同的扩展选项。

不同的探测任务类型，有不同的扩展选项，以下是不同协议的


                     {
                     "dns_server":"8.8.8.8"
                     }

返回数据


名称	类型	示例值	描述
AlertRule	String	[{"alarmActions":["默认报警联系人组"],"metricName":"Availability","expression":"$Availability<96"}]	创建/修改任务的时候同时设置报警规则，为一个jsonArray `[{"alarmActions":["xxx"],"metricName":"Availability","expression":"$Availability<96"}]`。 alarmActions：是对应报警联系组，metricName：对应的监控项，目前，可以取值为Availability(可用探测点百分比), AvailableNumber(可用探测点数)。
Code	String	200	状态码，200表示成功。
Data			创建任务结果详情。
AttachAlertResult			关联现有报警规则的状态。
Code	String	200	关联现有报警规则状态码，200表示成功。
Message	String	success	关联现有报警错误信息。
RequestId	String	32565d-233-1b98-2231-892813f86c71	关联现有报警规则请求ID。
RuleId	String	ruleId12345	关联现有报警规则ID。
Success	String	true	关联现有报警规则是否成功
Message	String	Successfully	返回消息。
RequestId	String	68192f5d-0d45-4b98-9724-892813f86c71	请求的ID，用于排查问题。
Success	String	true	是否成功。

示例

请求示例


http(s)://[Endpoint]/?Action=CreateSiteMonitor
&Address=http://www.aliyun.com
&TaskName=网站探测
&TaskType=HTTP
&<公共请求参数>

正常返回示例

XML 格式

<CreateSiteMonitorResponse>
    <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
    <Success>true</Success>
    <Code>200</Code>
    <Message>请求成功</Message>
</CreateSiteMonitorResponse>

JSON 格式

{
	"Message":"请求成功",
	"Success":true,
	"Code":"200"
}

错误码

访问错误中心查看更多错误码。