Creates a site monitoring task.

This topic provides an example on how to create a site monitoring task named HanZhou_ECS1. The URL that is monitored by the task is https://www.aliyun.com and the type of the task is HTTPS.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateSiteMonitor

The operation that you want to perform. Set the value to CreateSiteMonitor.

Address String Yes https://www.aliyun.com

The URL or IP address that is monitored by the task.

TaskType String Yes HTTPS

The type of the site monitoring task.

Valid values: HTTP, HTTPS, PING, TCP, UDP, DNS, SMTP, POP3, and FTP.

TaskName String Yes HanZhou_ECS1

The name of the site monitoring task.

The name must be 4 to 100 characters in length, and can contain letters, digits, and underscores (_).

Interval String No 1

The interval at which detection requests are sent.

Valid values: 1, 5, 15, 30, and 60. Unit: minutes.

Default value: 1.

IspCities String No [{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]

The information of the detection points. If you leave this parameter empty, the system randomly selects three detection points.

The value is a JSON array. Example: [{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]. The values of the city field indicate Beijing, Hangzhou, and Qingdao.

For information about how to obtain detection points, see DescribeSiteMonitorISPCityList.

OptionsJson String No {"time_out":5000}

The extended options of the protocol that is used by the site monitoring task. The options vary based on the protocol.

AlertIds String No SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent

The ID of the alert rule.

For information about how to obtain the ID of an alert rule, see DescribeMetricRuleList.

The following tables describe the extended options of the HTTP, HTTPS, PING, TCP, UDP, DNS, SMTP. POP3, and FTP protocols specified by the TaskType parameter.

  • HTTP or HTTPS

Parameter

Type

Description

http_method

String

The HTTP or HTTPS request method. Valid values: GET, POST, and HEAD. Default value: GET.

header

String

The custom HTTP headers that are separated by line feeds (\n).

Each header must comply with the HTTP protocol. Each header must be a key-value pair in which the key and value are separated by a colon (:).

cookie

String

The HTTP cookie that is specified in compliance with the HTTP request standard.

request_content

String

The content of the request. The content can be in the JSON or form format. If this parameter is not specified, the request body is empty.

response_content

String

The expected content of the response. The first 64 bytes of the content returned by the HTTP server are checked during site monitoring.

match_rule

String

0: If the response does not contain the content specified by the response_content parameter, the detection is successful.

1: If the response contains the content specified by the response_content parameter, the detection is successful.

username

String

If the username parameter is specified, the HTTP request contains the basic authentication header.

password

String

The password that is used to authenticate the HTTP or HTTPS request.

time_out

int

The timeout period. Unit: milliseconds. Default value: 5.

max_redirect

int

The maximum number of redirections. The default value is 5 for a detection point that is running on an Elastic Compute Service (ECS) instance and 2 for a detection point that is provided by a carrier.

To disable redirections, set the value to 0.

Valid values: 0 to 50.

  • PING

Parameter

Type

Description

failure_rate

Text

If the rate of the failed pings exceeds the value of this parameter, the detection fails and the status code 610 or 615 is returned. The error message of the status code 610 is PingAllFail and the error message of the status code 615 is PingPartialFail.

Default value: 0.1.

ping_num

int

The number of times that the monitored address is pinged. Default value: 10.

Valid values: 1 to 100.

  • DNS

Parameter

Type

Description

dns_server

string

The domain name or IP address of the Domain Name System (DNS) server.

dns_type

string

The type of the DNS records to query. Valid values: A, NS, CNAME, MX, TXT, ANY, and AAAA.

expect_value

string

The list of expected values. Separate the expected values with space characters.

match_rule

string

The relationship between the list of expected values and the list of DNS results. If the two lists do not meet the specified relationship, the detection fails. Valid values:

Empty string or IN_DNS: The list of expected values is a subset of the list of DNS results.

DNS_IN: The list of DNS results is a subset of the list of expected values.

EQUAL: The list of DNS results is the same as the list of expected values.

ANY: The list of DNS results intersects with the list of expected values.

  • FTP

Parameter

Type

Description

port

int

The port number of the FTP server. If this parameter is not specified, the default value is used. The default port number is 21 for FTP and 990 for FTPS.

username

string

The username that is used to log on to the FTP server. If this parameter is not specified, anonymous logon is used.

password

string

The password that is used to log on to the FTP server.

  • POP3 or SMTP

Parameter

Type

Description

port

int

The port number of the POP3 or SMTP server. The default port number is 110 for POP3, 995 for POPS3, and 25 for SMTP.

username

string

The username that is used to log on to the POP3 or SMTP server. The username and password that are used to log on to the POP3 or SMTP server are required.

password

string

The password that is used to log on to the POP3 or SMTP server. The username and password that are used to log on to the POP3 or SMTP server are required.

  • TCP or UDP

Parameter

Type

Description

port

int

The port number of the TCP or UDP server.

request_content

string

The content of the request. If the request_format parameter is set to hex, the value of the request_content parameter is parsed in the hexadecimal format.

request_format

string

If the request_format parameter is set to another value, the value of the request_content parameter is sent to the TCP or UDP server as a regular string.

response_content

string

The content of the response. If the response from the TCP or UDP server does not contain the content specified by the response_content parameter, the detection fails.

If the response_format parameter is set to hex, the value of the response_content parameter is parsed in the hexadecimal format.

If the response_format parameter is set to another value, the value of the response_content parameter is parsed as a regular string.

Response parameters

Parameter Type Example Description
Code String 200

The HTTP status code.

Note The status code 200 indicates that the call was successful.
Message String Successful

The returned message.

RequestId String 68192f5d-0d45-4b98-9724-892813f86c71

The ID of the request.

Success String true

Indicates whether the call was successful. Valid values:

  • true: The call was successful.
  • false: The call failed.
Data Object

The result of the site monitoring task.

AttachAlertResult Array of Contact

The result that is returned after you associate the existing alert rule with the site monitoring task.

Contact
Code String 200

The status code that is returned after you associate the existing alert rule with the site monitoring task.

Note The status code 200 indicates that the call was successful.
Message String successful

The message that is returned after you associate the existing alert rule with the site monitoring task.

RequestId String 5dd33455-4f65-4b0c-9200-33d66f3f340b

The ID of the request that was sent to associate the existing alert rule with the site monitoring task.

Success String true

Indicates whether the existing alert rule was associated with the site monitoring task. Valid values:

  • true
  • false
RuleId String SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent

The ID of the alert rule.

CreateResultList Array of CreateResultList

The result of the request.

If a site monitoring task is created, the result is returned. If a site monitoring task fails to be created, no result is returned.

CreateResultList
TaskId String 2c8dbdf9-a3ab-46a1-85a4-f094965e****

The ID of the site monitoring task.

TaskName String HanZhou_ECS1

The name of the site monitoring task.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateSiteMonitor
&Address=https://www.aliyun.com
&TaskName=HanZhou_ECS1
&TaskType=HTTPS
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateSiteMonitorResponse>
	<Message>successful</Message>
	<RequestId>68192f5d-0d45-4b98-9724-892813f86c71</RequestId>
	<Data>
		<AttachAlertResult>
			<Contact>
				<Message>successful</Message>
				<RequestId>5dd33455-4f65-4b0c-9200-33d66f3f340b</RequestId>
				<RuleId>SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent</RuleId>
				<Code>200</Code>
				<Success>true</Success>
			</Contact>
		</AttachAlertResult>
	</Data>
	<Code>200</Code>
	<CreateResultList>
		<CreateResultList>
			<TaskId>2c8dbdf9-a3ab-46a1-85a4-f094965e****</TaskId>
			<TaskName>HanZhou_ECS1</TaskName>
		</CreateResultList>
	</CreateResultList>
	<Success>true</Success>
</CreateSiteMonitorResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Message" : "successful",
  "RequestId" : "68192f5d-0d45-4b98-9724-892813f86c71",
  "Data" : {
    "AttachAlertResult" : {
      "Contact" : [ {
        "Message" : "successful",
        "RequestId" : "5dd33455-4f65-4b0c-9200-33d66f3f340b",
        "RuleId" : "SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent",
        "Code" : "200",
        "Success" : true
      } ]
    }
  },
  "Code" : "200",
  "CreateResultList" : {
    "CreateResultList" : [ {
      "TaskId" : "2c8dbdf9-a3ab-46a1-85a4-f094965e****",
      "TaskName" : "HanZhou_ECS1"
    } ]
  },
  "Success" : true
}

Error codes

For a list of error codes, see Service error codes.