| object | | |
Code | string | The response code.
Note
The status code 200 indicates that the request was successful.
| 200 |
Message | string | | successful |
RequestId | string | | D17DF650-7EBD-54D0-903A-1D4E624D7402 |
Success | boolean | Indicates whether the request was successful. Valid values:
| true |
SiteMonitors | object | The details of the site monitoring task. | |
TaskType | string | The protocol that is used by the site monitoring task. Valid values: HTTP, HTTPS, PING, TCP, UDP, DNS, SMTP, POP3, and FTP. | HTTP |
Interval | string | The interval at which the site monitoring task is executed. Unit: minutes. Valid values: 1, 5, 15, 30, and 60. | 1 |
TaskState | string | The status of the site monitoring task. Valid values:
- 1: The task is enabled.
- 2: The task is disabled.
| 1 |
TaskName | string | The name of the site monitoring task. | test123 |
Address | string | The URL that is monitored by the site monitoring task. | https://aliyun.com |
TaskId | string | The ID of the site monitoring task. | cc641dff-c19d-45f3-ad0a-818a0c4f**** |
IspCities | object [] | The information of detection points. The information includes the carriers that provide the detection points and the cities where the detection points reside. | |
City | string | | 738 |
IspName | string | | |
Isp | string | | 465 |
CityName | string | | |
OptionJson | object | The extended options of the site monitoring task. The options vary based on the specified protocol. For more information, see CreateSiteMonitor . | |
request_format | string | The format of the HTTP request. Valid values:
- hex: hexadecimal
- txt: text
| txt |
response_content | string | The response to the HTTP request. | txt |
port | integer | The port number of the TCP, UDP, SMTP, or POP3 protocol. | 110 |
authentication | integer | Indicates whether the security authentication feature is enabled. Valid values:
- 0: The feature is disabled.
- 1: The feature is enabled.
| 1 |
match_rule | integer | Indicates whether the alert rule is included. Valid values:
- 0: The alert rule is included.
- 1: The alert rule is excluded.
| 1 |
dns_match_rule | string | The relationship between the list of expected aliases or IP addresses and the list of DNS results. Valid values:
- 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.
| IN_DNS |
request_content | string | The content of the HTTP request. | aa=bb |
username | string | The username of the FTP, SMTP, or POP3 protocol. | testUser |
dns_type | string | The type of the DNS record. This parameter is returned only if the TaskType parameter is set to DNS. Valid values:
- A (default): a record that specifies an IP address related to the specified host name or domain name.
- CNAME: a record that maps multiple domain names to a domain name.
- NS: a record that specifies a DNS server used to parse domain names.
- MX: a record that links domain names to the address of a mail server.
- TXT: a record that stores the text information of host name or domain names. The text must be 1 to 512 bytes in length. The TXT record serves as a Sender Policy Framework (SPF) record to fight against spam.
| A |
response_format | string | The format of the HTTP response. Valid values:
- hex: hexadecimal
- txt: text
| txt |
password | string | The password of the SMTP, POP3, or FTP protocol. | 123**** |
expect_value | string | The domain name or alias to be parsed.
Note
This parameter is returned only if the TaskType parameter is set to DNS.
| dns_server |
time_out | long | The timeout period. Unit: milliseconds. | 3 |
failure_rate | float | The packet loss rate.
Note
This parameter is returned only if the TaskType parameter is set to PING.
| 0.4 |
cookie | string | The cookie of the HTTP request. | lang=en |
ping_num | integer | The heartbeat of the PING protocol. | 29 |
http_method | string | The HTTP request method. Valid values:
| get |
dns_server | string | The IP address of the DNS server.
Note
This parameter is returned only if the TaskType parameter is set to DNS.
| 192.168.XX.XX |
attempts | long | The number of retries after a DNS failure occurred. | 3 |
protocol | string | The protocol that is used to send the request. | TCP |
MetricRules | object [] | The information of the alert rules that are configured for the site monitoring task. | |
MetricName | string | | Availability |
EvaluationCount | string | The consecutive number of times for which the metric value meets the alert condition before an alert is triggered. | 3 |
Namespace | string | The namespace of the cloud service.
The value is in the following format: acs_service name. | acs_networkmonitor |
OkActions | string | The alert contact group that receives alert notifications. | [ "CloudMonitor"] |
AlarmActions | string | The alert contact group to which alert notifications are sent. | CloudMonitor |
RuleId | string | The ID of the alert rule. | bf071ae_7b7aec3817b0fdf**** |
RuleName | string | The name of the alert rule. | rule1 |
Period | string | The time interval. The value is the same as the interval at which metric data is reported. Unit: seconds.
Note
If you specify a statistical period for the alert rule, data is queried based on the statistical period.
| 15s |
ComparisonOperator | string | The operator that is used to compare the metric value with the threshold in the alert rule. Valid values:
>=
>
<=
<
=
!=
- GreaterThanYesterday: greater than the metric value at the same time yesterday
- LessThanYesterday: less than the metric value at the same time yesterday
- GreaterThanLastWeek: greater than the metric value at the same time last week
- LessThanLastWeek: less than the metric value at the same time last week
- GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle
- LessThanLastPeriod: less than the metric value in the last monitoring cycle
| GreaterThanYesterday |
Expression | string | The expression that is used to trigger alerts. | $Availability=30 |
Dimensions | string | The dimension of the alert rule. | [{"taskId": "cc641dff-c19d-45f3-ad0a-818a0c4f****" }] |
StateValue | string | The alert status. Valid values:
- OK: The alert rule has no active alerts.
- ALARM: The alert rule has active alerts.
| OK |
ActionEnable | string | Indicates whether the alert rule is enabled. Valid values:
- true: The alert rule is enabled.
- false: The alert rule is disabled.
| true |
Level | string | The alert severity. Valid values:
- 1: critical
- 2: warning
- 3: information
| 2 |
Threshold | string | | 30 |
Statistics | string | The statistical method of the alert rule. Valid values:
- Availability: the percentage of available detection points
- AvailableNumber: the number of available detection points
- ErrorCodeMaximum: a status code for an alert
- ErrorCodeMinimum: all status codes for a set of alerts
- Average: response time
| Availability |