DescribeSiteMonitorAttribute-阿里云帮助中心

Queries the details of a site monitoring task.

Operation description

This topic provides an example of querying the details of the site monitoring task cc641dff-c19d-45f3-ad0a-818a0c4f****. The response shows that the name of the site monitoring task is test123, the probe address is https://aliyun.com, and the carrier is Alibaba.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cms:DescribeSiteMonitorAttribute

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TaskId	string	Yes	The ID of the site monitoring task.	cc641dff-c19d-45f3-ad0a-818a0c4f****
IncludeAlert	boolean	No	Specifies whether the returned task details include alert rules. Valid values: true: The alert rules are returned. false: The alert rules are not returned. Default value: false.	false

For more information about common request parameters, see Common parameters.

Response elements

Element	Type	Description	Example
	object	The response.
Code	string	The status code. Note A value of 200 indicates success.	200
Message	string	The response message.	successful
MetricRules	object
MetricRule	array<object>	The alert rules for the monitoring task.
	object	The alert rules for the monitoring task.
ActionEnable	string	The status of the alert rule. Valid values: true: enabled false: disabled	true
AlarmActions	string	The alert contact groups that receive notifications for the alert rule.	CloudMonitor
ComparisonOperator	string	The threshold comparison operator of the alert rule. Valid values: `>=` `>` `<=` `<` `=` `!=` GreaterThanYesterday: greater than the value at the same time yesterday LessThanYesterday: less than the value at the same time yesterday GreaterThanLastWeek: greater than the value at the same time last week LessThanLastWeek: less than the value at the same time last week GreaterThanLastPeriod: greater than the value in the previous period LessThanLastPeriod: less than the value in the previous period	GreaterThanYesterday
Dimensions	string	The dimensions associated with the alert rule.	[{"taskId": "cc641dff-c19d-45f3-ad0a-818a0c4f****" }]
EvaluationCount	string	The number of alert retries.	3
Expression	string	The expression of the alert rule.	$Availability=30
Level	string	The level of the alert rule. Valid values: 1: critical 2: warning 3: information	2
MetricName	string	The name of the metric.	Availability
Namespace	string	The data namespace of the Alibaba Cloud service.	acs_networkmonitor
OkActions	string	The contact groups that receive alert notifications.	[ "CloudMonitor"]
Period	string	The time interval. This is typically the reporting period of the metric. Unit: seconds. Note If you set a statistical period, the corresponding statistical data is queried based on this period.	15s
RuleId	string	The ID of the alert rule.	bf071ae_7b7aec3817b0fdf****
RuleName	string	The name of the alert rule.	rule1
StateValue	string	The status of the alert. Valid values: OK: normal ALARM: alert	OK
Statistics	string	The statistical method for the alert. Valid values: Availability: percentage of available detection points AvailableNumber: number of available detection points ErrorCodeMaximum: any status code (independent alert) ErrorCodeMinimum: all status codes (combined alert) Average: response time	Availability
Threshold	string	The alert threshold.	30
RequestId	string	The request ID.	D17DF650-7EBD-54D0-903A-1D4E624D7402
SiteMonitors	object	The details of the monitoring task.
Address	string	The target address of the monitoring task.	https://aliyun.com
AgentGroup	string	The type of the detection point. Default value: PC. Valid values: PC: fixed network MOBILE: mobile network	PC
CustomSchedule	object	The custom detection period. You can only select a specific time period from Monday to Sunday for detection.
days	object
days	array	The detection days.
	integer	The detection days.	1
end_hour	integer	The end time of the custom detection. Unit: hours.	18
start_hour	integer	The start time of the custom detection. Unit: hours.	8
time_zone	string	The time zone for the custom detection.	local
Interval	string	The interval of the monitoring task. Unit: minutes. Valid values: 1, 5, 15, 30, and 60.	1
IspCities	object
IspCity	array<object>	The carrier and city of the detection point.
	object	The carrier and city of the detection point.
City	string	The city ID.	738
CityName	string	The city name.	Beijing
Isp	string	The carrier ID.	465
IspName	string	The carrier name.	Alibaba
Type	string	The network type of the detection point. Valid values: IDC: IDC data center LASTMILE: residential broadband MOBILE: mobile cellular network	IDC
OptionJson	object	The extended options. Each detection type has different extended options. For more information, see CreateSiteMonitor.
assertions	object
assertions	array<object>	The assertion configuration group.
	object	The assertion configuration group.
operator	string	The assertion comparison operator. Valid values: contains: contains doesNotContain: does not contain matches: regular expression match doesNotMatch: regular expression mismatch is: numeric equality or character match isNot: not equal to lessThan: less than moreThan: greater than	lessThan
property	string	The parsing path for the assertion content. If the assertion type is `body_json`, the path is a JSON path. If the assertion type is `body_xml`, the path is an XML path.	json path
target	string	The target numeric value or character for assertion matching and comparison.	0
type	string	The assertion type. Valid values: response_time: determines whether the response time meets expectations status_code: determines whether the HTTP response status code meets expectations header: determines whether the fields in the response header meet expectations body_text: determines whether the content in the response body meets expectations by using text character matching body_json: determines whether the content in the response body meets expectations by using JSON parsing (JSON Path) body_xml: determines whether the content in the response body meets expectations by using XML parsing (XPath)	response_time
attempts	integer	The number of retries after a DNS failure.	3
auth_info	object	The authentication information.
type	string	The authentication type. Currently, HTTP Basic Authentication is supported. Valid value: basic.	basic
username	string	The username used for HTTP Basic Authentication.	test_username
password	string	The password used for HTTP Basic Authentication.	test_password
use_cookie_session_key	boolean	In digest authentication, this parameter specifies whether the key is stored in the cookie of the client.	false
grant_type	string	The authentication type used in OAuth 2.0 authentication. Valid values: client_credentials and password.	password
client_id	string	The client ID used for client authentication in OAuth 2.0.	client_id
client_secret	string	The client secret used for client authentication in OAuth 2.0.	client_secret
scopes	object
scopes	array	The requested permission scopes in OAuth 2.0.
	string	A single requested permission in OAuth 2.0.	test_operation
token_url	string	The authentication server address in OAuth 2.0.	https://www.example.com
auth_style	string	The OAuth 2.0 authentication style. Valid values: ROA and RPC.	ROA
access_key_id	string	Supported only in multi-step monitoring. The AccessKey ID passed when using Alibaba Cloud authentication. Store it in an encrypted format.	testAk
access_key_secret	string	Supported only in multi-step monitoring. The AccessKey secret passed when using Alibaba Cloud authentication. Store it in an encrypted format.	testSk
region_id	string	Supported only in multi-step monitoring. The region ID of the request when using Alibaba Cloud authentication.	cn-hangzhou
api_action	string	Supported only in multi-step monitoring. The requested API operation when using Alibaba Cloud operations.	example_api
api_version	string	Supported only in multi-step monitoring. The requested API version when using Alibaba Cloud operations.	2019-01-01
with_addon_resources	boolean	Supported only in multi-step monitoring. Specifies whether the operation has additional resources when this step uses Alibaba Cloud authentication.	false
service_name	string	The service name when using AWS authentication.	example_service_name
session_token	string	The session token used for AWS authentication.	example_token
blocked_url_list	object
blocked_url_list	array	The list of blocked resource URLs. Path wildcards are supported.
	string	The list of blocked resource URLs. Path wildcards are supported.	www.taobao.com/**
browser_headers	object
browser_headers	array<object>	The custom headers. The structure is `{"key": "somekey", "value":"somevalue"}`.
	object	The custom headers. The structure is `{"key": "somekey", "value":"somevalue"}`.	{"key":"value"}
browser_hosts	object
browser_hosts	array	The custom hosts. The structure is `{"url":"someurl", "ip":"someip"}`.
	string	The custom hosts. The structure is `{"url":"someurl", "ip":"someip"}`.	{"url":"www.taobao.com","ip":"127.0.0.1"}
browser_info	object
browser_info	array<object>	The browser information.
	object	The browser information.
browser	string	The type of the browser.	Chrome
device	string	The device type.	laptop
browser_insecure	boolean	Specifies whether to ignore certificate errors. Valid values: false: do not ignore certificate errors true: ignore certificate errors	false
browser_task_version	string	The browser monitoring version. Valid values: 1: Single-page monitoring. 2: Multi-page monitoring.	1
cookie	string	The cookie sent in the HTTP request.	lang=en
diagnosis_mtr	boolean	Specifies whether to enable automatic MTR network diagnostics after a task fails. Valid values: false: Automatic MTR network diagnostics are disabled. true: Automatic MTR network diagnostics are enabled.	false
diagnosis_ping	boolean	Specifies whether to enable automatic PING network latency probing after a task fails. Valid values: false: Automatic PING network latency probing is disabled. true: Automatic PING network latency probing is enabled.	false
dns_hijack_whitelist	string	The DNS hijacking whitelist.	www.taobao.com:www.taobao.com.danuoyi.tbcache.com
dns_match_rule	string	The DNS matching rule. Valid values: IN_DNS: The expected aliases or IP addresses are all included in the DNS response. DNS_IN: All DNS responses are included in the expected aliases or IP addresses. EQUAL: The DNS response exactly matches the expected aliases or IP addresses. ANY: The DNS response and the expected aliases or IP addresses have an intersection.	IN_DNS
dns_server	string	The IP address of the DNS server. Note This parameter applies only to the DNS monitoring type.	192.168.XX.XX
dns_type	string	The DNS record type. This parameter applies only to the DNS monitoring type. Valid values: A: Specifies the IP address that corresponds to a hostname or domain name. CNAME: Maps multiple domain names to another domain name. NS: Specifies the DNS server that resolves a domain name. MX: Points a domain name to a mail server address. TXT: Provides a description of a hostname or domain name. The text length is limited to 512 bytes. It is typically used as a Sender Policy Framework (SPF) record for anti-spam purposes.	A
empty_message	boolean	Specifies whether to allow a WebSocket task to return no message or an empty message. Valid values: false (default): No. true: Yes.	false
expect_exist_string	object
expect_exist_string	array	The list of strings expected to exist on the page.
	string	The list of strings expected to exist on the page.	expected string
expect_non_exist_string	object
expect_non_exist_string	array	The list of strings expected not to exist on the page.
	string	The list of strings expected not to exist on the page.	unexpected string
expect_value	string	The alias or address to be resolved. Note This parameter applies only to the DNS monitoring type.	dns_server
failure_rate	number	The packet loss rate. Note This parameter applies only to the PING monitoring type.	0.4
header	string	The HTTP request header.	testKey:testValue
http_method	string	The HTTP request method. Valid values: get post head	get
ip_network	string	The network type of the task. Valid values: v4, v6, and auto. Default value: v4.	v4
isBase64Encode	string	Specifies whether to store the password in Base64 encoding. Valid values: true: The password is stored in Base64 encoding. false: The password is not stored in Base64 encoding.	false
match_rule	integer	Specifies whether alert rules are included. Valid values: 0: Yes. 1: No.	1
min_tls_version	string	The minimum TLS version. By default, TLS 1.2 and later versions are supported. TLS 1.0 and 1.1 are disabled. You can modify the configuration to enable them if needed.	tlsv1.2
password	string	The password for the SMTP, POP3, or FTP monitoring type.	123****
ping_num	integer	The heartbeat for the PING monitoring type.	29
ping_port	integer	The PING port. This parameter applies to TCP PING.	80
ping_type	string	The PING protocol type. Valid values: icmp tcp udp	icmp
port	integer	The port for the TCP, UDP, SMTP, or POP3 monitoring type.	110
protocol	string	The monitoring protocol.	TCP
quic_enabled	boolean	Specifies whether the browser monitoring task uses the QUIC protocol. Valid values: true: The QUIC protocol is used. false: The QUIC protocol is not used. Default value: false.	true
quic_target	object
quic_target	array	The list of sites that are forced to use the QUIC protocol.
	string	The site that is forced to use the QUIC protocol. The format is url:port. The port is optional and defaults to 443.	www.taobao.com
request_content	string	The request content for the HTTP monitoring type.	aa=bb
request_format	string	The format of the HTTP request content. Valid values: hex: Hexadecimal format. txt: Text format.	txt
response_content	string	The expected response content to match.	txt
response_format	string	The format of the HTTP response content. Valid values: hex: Hexadecimal format. txt: Text format.	txt
retry_delay	integer	The number of retries after a monitoring task fails.	0
screen_shot	boolean	Specifies whether to enable page screenshots.	false
strict_mode	boolean		false
time_out	integer	The timeout period. Unit: milliseconds.	3
traffic_hijack_element_blacklist	object
traffic_hijack_element_blacklist	array	When a redirect occurs, if the URL of the resource loaded by the browser matches any expression in this list, traffic hijacking is considered to have occurred.
	string	When a redirect occurs, if the URL of the resource loaded by the browser matches any expression in this list, traffic hijacking is considered to have occurred.	www.taobao.com
traffic_hijack_element_count	integer	When a redirect occurs, if the number of resources loaded by the browser exceeds this value, traffic hijacking is considered to have occurred. If this value is 0, no verification is performed. Default value: 0.	0
traffic_hijack_element_whitelist	object
traffic_hijack_element_whitelist	array	When a redirect occurs, if the URL of the resource loaded by the browser does not match any expression in this list, traffic hijacking is considered to have occurred.
	string	When a redirect occurs, if the URL of the resource loaded by the browser does not match any expression in this list, traffic hijacking is considered to have occurred.	www.taobao.com
username	string	The username for FTP, SMTP, or POP3.	testUser
waitTime_after_completion	integer	The additional waiting time after the page is opened in a browser monitoring task.	3
scroll_end	boolean	Specifies whether to scroll to the bottom of the page after it is opened. This parameter applies only to browser monitoring tasks.	false
host_binding	string	The custom host for an HTTP task. The format is ip1,ip2:address. You can configure multiple lines of mappings. The left side of the colon contains the A records or CNAMEs to which the domain name can be resolved, separated by commas. The right side of the colon is the domain name.	127.0.0.1:www.aliyun.com
host_binding_type	integer	Specifies the effective mode of the custom host. Valid values: 0: random. 1: round-robin. Valid values: 0 : 0 1 : 1	0
hops	integer	The number of hops for traceroute diagnostics when a PING task fails.	20
icmp_timeout_millis	integer	The timeout period for a single PING request in a PING task that uses the ICMP protocol. Unit: milliseconds.	3000
config_variables	object
config_variables	array<object>	The environment variable configurations. This parameter applies to multi-step monitoring tasks.
	object	Environment variables can be referenced in the parameters of different test steps by using the placeholder {{$.VariableName}}. You can also parse the returned content from a test step, update the corresponding variable, and reference it in subsequent test steps. For sensitive information such as API keys, you can select encrypted storage.
name	string	The name of the environment variable.	variable_name
value	string	The value of the variable.	variable_value
secure	boolean	Specifies whether to enable encrypted storage.	true
steps	object
steps	array<object>	The step configurations in a multi-step monitoring task. This parameter applies to multi-step monitoring tasks.
	array<object>	The configuration of a single step in a multi-step monitoring task.
name `deprecated`	string	[Deprecated] The name of the step.	step1
step_type	string	The monitoring type of the step. Valid values: http ping tcp udp dns smtp pop3 ftp wait: The wait step.	http
url	string	The URL for a single step in a multi-step monitoring task.	https://aliyun.com
allow_failure	boolean	Specifies whether to proceed to the next step if the current step fails. Default value: false.	true
is_critical	boolean	Specifies whether to mark the entire monitoring task as failed if the current step fails. Default value: false.	true
wait_time_in_secs	integer	The waiting time. Unit: seconds.	5
extracted_variables	object
extracted_variables	array<object>	The variable extraction configurations.
	array<object>	The configuration for extracting a single variable.
name	string	The name of the variable.	test_variable
parser	object	The settings for the variable extraction method.
parser_type	string	The mode for extracting variables. Valid values: 0: JSON. 1: XML. 2: Regular expression.	0
value	string	The variable extraction expression. When the extraction method is JSON or XML, the variable extraction expression supports the XML format. When the extraction method is regular expression, the string that matches this value is extracted.	x.testkey.arrayvalue[0].innerkey
field	string	This parameter takes effect when the variable location is the HTTP header. It extracts the key pointed to by this option in the header.	request_id
extracted_type	string	The location from which the variable is extracted. Valid values: 0: HTTP body. 1: HTTP header.	1
option	string	The extended options for the step. Each monitoring type has different extended options. For more information, see CreateSiteMonitor.	{"enable_operator_dns": true}
step_name	string	The name of the step.	step1
use_generated_cookie	boolean	Specifies whether to use the cookie extracted before this step. Default value: false.	true
auto_extract_cookie	boolean	Specifies whether to automatically extract cookies. If enabled, the Set-Cookie header returned by the HTTP request in this step is parsed and made available to subsequent monitoring steps. Default value: false.	true
trace_region	string	The deployment region of the target application when integrating with the OpenTelemetry edition of Tracing Analysis.	cn-hangzhou
trace_type	string	The tracing protocol used when integrating with the OpenTelemetry edition of Tracing Analysis. Valid values: OpenTelemetry Zipkin Jaeger	OpenTelemetry
safe_link	integer	This parameter applies to SMTP tasks. If set to 1, a secure connection is used. Default value: 0.	0
enable_packet_capture	boolean	Specifies whether to enable packet capture for the task.	true
use_private_crt	boolean	Specifies whether to use a private certificate.
private_crt_file_name	string	The private certificate file name.	cert.pem
use_ssl	boolean	Specifies whether to use an SSL connection when executing a TCP task.	tlsv1.0
max_tls_version	string	The maximum TLS version.	tlsv1.3
server_name	string	The server name indication.	www.aliyun.com
supported_cipher_suits	string	The supported cipher suites.	TLS_AES_256_GCM_SHA384
sse	boolean	Specifies whether to perform SSE probing.
TaskId	string	The ID of the site monitoring task.	cc641dff-c19d-45f3-ad0a-818a0c4f****
TaskName	string	The name of the monitoring task.	test123
TaskState	string	The state of the monitoring task. Valid values: 1: Enabled. 2: Disabled.	1
TaskType	string	The type of the monitoring task. Site monitoring tasks support the following types: HTTP(S), PING, TCP, UDP, DNS, SMTP, POP3, and FTP.	HTTP
VpcConfig	object	The VPC configuration for the internal network probing task.
Region	string	The region where the target site of the internal network probing task is located.	cn-beijing
SecurityGroupId	string	The ID of the security group associated with the internal network probing task.	sg-xxxxxx
VpcId	string	The ID of the VPC to which the internal network probing task is attached.	vpc-xxxxxx
VswitchId	string	The ID of the vSwitch to which the internal network probing task is attached.	vsw-xxxxxx
Success	boolean	Indicates whether the operation is successful. Valid values: true: Successful. false: Failed.	true

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "successful",
  "MetricRules": {
    "MetricRule": [
      {
        "ActionEnable": "true",
        "AlarmActions": "CloudMonitor",
        "ComparisonOperator": "GreaterThanYesterday",
        "Dimensions": "[{\"taskId\": \"cc641dff-c19d-45f3-ad0a-818a0c4f****\" }]",
        "EvaluationCount": "3",
        "Expression": "$Availability=30",
        "Level": "2",
        "MetricName": "Availability",
        "Namespace": "acs_networkmonitor",
        "OkActions": "[ \"CloudMonitor\"]",
        "Period": "15s",
        "RuleId": "bf071ae_7b7aec3817b0fdf****",
        "RuleName": "rule1",
        "StateValue": "OK",
        "Statistics": "Availability",
        "Threshold": "30"
      }
    ]
  },
  "RequestId": "D17DF650-7EBD-54D0-903A-1D4E624D7402",
  "SiteMonitors": {
    "Address": "https://aliyun.com",
    "AgentGroup": "PC",
    "CustomSchedule": {
      "days": {
        "days": [
          1
        ]
      },
      "end_hour": 18,
      "start_hour": 8,
      "time_zone": "local"
    },
    "Interval": "1",
    "IspCities": {
      "IspCity": [
        {
          "City": "738",
          "CityName": "Beijing",
          "Isp": "465",
          "IspName": "Alibaba",
          "Type": "IDC"
        }
      ]
    },
    "OptionJson": {
      "assertions": {
        "assertions": [
          {
            "operator": "lessThan",
            "property": "json path",
            "target": "0",
            "type": "response_time"
          }
        ]
      },
      "attempts": 3,
      "auth_info": {
        "type": "basic",
        "username": "test_username",
        "password": "test_password",
        "use_cookie_session_key": false,
        "grant_type": "password",
        "client_id": "client_id",
        "client_secret": "client_secret",
        "scopes": {
          "scopes": [
            "test_operation"
          ]
        },
        "token_url": "https://www.example.com",
        "auth_style": "ROA",
        "access_key_id": "testAk",
        "access_key_secret": "testSk",
        "region_id": "cn-hangzhou",
        "api_action": "example_api",
        "api_version": "2019-01-01",
        "with_addon_resources": false,
        "service_name": "example_service_name",
        "session_token": "example_token"
      },
      "blocked_url_list": {
        "blocked_url_list": [
          "www.taobao.com/**"
        ]
      },
      "browser_headers": {
        "browser_headers": [
          {
            "key": "value"
          }
        ]
      },
      "browser_hosts": {
        "browser_hosts": [
          "{\"url\":\"www.taobao.com\",\"ip\":\"127.0.0.1\"}"
        ]
      },
      "browser_info": {
        "browser_info": [
          {
            "browser": "Chrome",
            "device": "laptop"
          }
        ]
      },
      "browser_insecure": false,
      "browser_task_version": "1",
      "cookie": "lang=en",
      "diagnosis_mtr": false,
      "diagnosis_ping": false,
      "dns_hijack_whitelist": "www.taobao.com:www.taobao.com.danuoyi.tbcache.com",
      "dns_match_rule": "IN_DNS",
      "dns_server": "192.168.XX.XX",
      "dns_type": "A",
      "empty_message": false,
      "expect_exist_string": {
        "expect_exist_string": [
          "expected string"
        ]
      },
      "expect_non_exist_string": {
        "expect_non_exist_string": [
          "unexpected string"
        ]
      },
      "expect_value": "dns_server",
      "failure_rate": 0.4,
      "header": "testKey:testValue",
      "http_method": "get",
      "ip_network": "v4",
      "isBase64Encode": "false",
      "match_rule": 1,
      "min_tls_version": "tlsv1.2",
      "password": "123****",
      "ping_num": 29,
      "ping_port": 80,
      "ping_type": "icmp",
      "port": 110,
      "protocol": "TCP",
      "quic_enabled": true,
      "quic_target": {
        "quic_target": [
          "www.taobao.com"
        ]
      },
      "request_content": "aa=bb",
      "request_format": "txt",
      "response_content": "txt",
      "response_format": "txt",
      "retry_delay": 0,
      "screen_shot": false,
      "strict_mode": false,
      "time_out": 3,
      "traffic_hijack_element_blacklist": {
        "traffic_hijack_element_blacklist": [
          "www.taobao.com"
        ]
      },
      "traffic_hijack_element_count": 0,
      "traffic_hijack_element_whitelist": {
        "traffic_hijack_element_whitelist": [
          "www.taobao.com"
        ]
      },
      "username": "testUser",
      "waitTime_after_completion": 3,
      "scroll_end": false,
      "host_binding": "127.0.0.1:www.aliyun.com",
      "host_binding_type": 0,
      "hops": 20,
      "icmp_timeout_millis": 3000,
      "config_variables": {
        "config_variables": [
          {
            "name": "variable_name",
            "value": "variable_value",
            "secure": true
          }
        ]
      },
      "steps": {
        "steps": [
          {
            "name": "step1",
            "step_type": "http",
            "url": "https://aliyun.com",
            "allow_failure": true,
            "is_critical": true,
            "wait_time_in_secs": 5,
            "extracted_variables": {
              "extracted_variables": [
                {
                  "name": "test_variable",
                  "parser": {
                    "parser_type": "0",
                    "value": "x.testkey.arrayvalue[0].innerkey"
                  },
                  "field": "request_id",
                  "extracted_type": "1"
                }
              ]
            },
            "option": "{\"enable_operator_dns\": true}",
            "step_name": "step1",
            "use_generated_cookie": true,
            "auto_extract_cookie": true
          }
        ]
      },
      "trace_region": "cn-hangzhou",
      "trace_type": "OpenTelemetry",
      "safe_link": 0,
      "enable_packet_capture": true,
      "use_private_crt": false,
      "private_crt_file_name": "cert.pem",
      "use_ssl": true,
      "max_tls_version": "tlsv1.3",
      "server_name": "www.aliyun.com",
      "supported_cipher_suits": "TLS_AES_256_GCM_SHA384",
      "sse": false
    },
    "TaskId": "cc641dff-c19d-45f3-ad0a-818a0c4f****",
    "TaskName": "test123",
    "TaskState": "1",
    "TaskType": "HTTP",
    "VpcConfig": {
      "Region": "cn-beijing",
      "SecurityGroupId": "sg-xxxxxx",
      "VpcId": "vpc-xxxxxx",
      "VswitchId": "vsw-xxxxxx"
    }
  },
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	ParameterInvalid	The parameter is missing or invalid. %s	The parameter is missing or invalid.
401	AccessDeniedException	You donot have sufficient access to perform this action.
500	InternalError	The request processing has failed due to some unknown error.
402	LimitExceeded	The quota for this customer had been reached.
403	Forbidden	You are not authorized to operate the specified resource.	No permission, please use RAM to authorize
404	Forbidden	Task Id does not exist
406	ExceedingQuota	Exceeding quota limits.	The number of tasks exceeds the limit
429	Throttlingexception	The request was denied due to request throttling.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.