Call DescribeSiteMonitorAttribute to query site monitoring task details - Cloud Monitor - Alibaba Cloud - Cloud Monitor

Calls the DescribeSiteMonitorAttribute operation to query the details of a site monitoring task.

Operation description

This topic provides an example of how to query the details of the site monitoring task cc641dff-c19d-45f3-ad0a-818a0c4f****. The returned results show that the site monitoring task is named test123, the monitored 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 monitoring task.	cc641dff-c19d-45f3-ad0a-818a0c4f****
IncludeAlert	boolean	No	Specifies whether the returned task details include alert rules. Valid values: true: Alert rules are returned. false (default): Alert rules are not returned.	false

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

Response elements

Element	Type	Description	Example
	object	The response result.
Code	string	The status code. A value of 200 indicates success.	200
Message	string	The returned message.	successful
MetricRules	object
MetricRule	array<object>	The alert rules of the monitoring task.
	object	The alert rules of 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: the metric value is greater than the value at the same time yesterday. LessThanYesterday: the metric value is less than the value at the same time yesterday. GreaterThanLastWeek: the metric value is greater than the value at the same time last week. LessThanLastWeek: the metric value is less than the value at the same time last week. GreaterThanLastPeriod: the metric value is greater than the value in the previous cycle. LessThanLastPeriod: the metric value is less than the value in the previous cycle.	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 severity 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 namespace of the Alibaba Cloud service data.	acs_networkmonitor
OkActions	string	The alert contact groups that receive alert notifications.	[ "CloudMonitor"]
Period	string	The time interval, which is typically the reporting cycle of the metric. Unit: seconds. Note If you configure a statistical period, the system queries the corresponding statistical data based on that 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 triggered.	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 probe address of the monitoring task.	https://aliyun.com
AgentGroup	string	The type of detection point. Default value: PC. Valid values: PC: fixed-line network. MOBILE: mobile network.	PC
CustomSchedule	object	The custom probe cycle. Probing can only be scheduled within a specific time range from Monday to Sunday.
days	object
days	array	The probe days.
	integer	The probe days.	1
end_hour	integer	The end time of the custom probe. Unit: hours.	18
start_hour	integer	The start time of the custom probe. Unit: hours.	8
time_zone	string	The time zone for the custom probe.	local
Interval	string	The cycle 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 probe 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: matches a regular expression. doesNotMatch: does not match a regular expression. is: equals a numeric value or matches a string. isNot: does not equal. lessThan: less than. moreThan: greater than.	lessThan
property	string	The parsing path of 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 value or string for the assertion comparison.	0
type	string	The assertion type. Valid values: response_time: checks whether the response time meets expectations. status_code: checks whether the HTTP response status code meets expectations. header: checks whether a field in the response header meets expectations. body_text: checks whether the content in the response body meets expectations using text string matching. body_json: checks whether the content in the response body meets expectations using JSON parsing (JSON Path). body_xml: checks whether the content in the response body meets expectations using XML parsing (XPath).	response_time
attempts	integer	The number of retries after a DNS failure.	3
auth_info	object	The authentication information.
access_key_id	string	Supported only in multi-step probing. The AccessKey ID used for Alibaba Cloud authentication. Store this value using encrypted storage.	testAk
access_key_secret	string	Supported only in multi-step probing. The AccessKey secret used for Alibaba Cloud authentication. Store this value using encrypted storage.	testSk
api_action	string	Supported only in multi-step probing. The API operation requested when using Alibaba Cloud operations.	example_api
api_version	string	Supported only in multi-step probing. The API version requested when using Alibaba Cloud operations.	2019-01-01
auth_style	string	The OAuth 2.0 authentication style. Valid values: ROA and RPC.	ROA
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
grant_type	string	The grant type used in OAuth 2.0 authentication. Valid values: client_credentials and password.	password
password	string	The password used for HTTP Basic Authentication.	test_password
region_id	string	Supported only in multi-step probing. The region ID of the request when using Alibaba Cloud authentication.	cn-hangzhou
scopes	object
scopes	array	The permission scopes requested in OAuth 2.0.
	string	A single permission scope requested in OAuth 2.0.	test_operation
service_name	string	The service name of the request when using AWS authentication.	example_service_name
session_token	string	The session token used for AWS authentication.	example_token
token_url	string	The authorization server URL used in OAuth 2.0.	https://www.example.com
type	string	The authentication type. Currently supports HTTP Basic Authentication. Valid value: basic.	basic
use_cookie_session_key	boolean	Specifies whether the key is stored in the client cookie during digest authentication.	false
username	string	The username used for HTTP Basic Authentication.	test_username
with_addon_resources	boolean	Supported only in multi-step probing. Specifies whether additional resources exist for the operation when using Alibaba Cloud authentication in this step.	false
blocked_url_list	object
blocked_url_list	array	The list of blocked resource URLs. Supports path wildcards.
	string	The list of blocked resource URLs. Supports path wildcards.	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 screen 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
config_variables	object
config_variables	array<object>	The environment variable configuration. Takes effect for multi-step monitoring.
	object	The environment variable that can be referenced in parameters across different test steps using the placeholder {{$.variableName}}. The variable can also be updated by parsing the response from one test step and used in subsequent steps. For sensitive information such as API keys, you can enable encrypted storage.
name	string	The name of the environment variable.	variable_name
secure	boolean	Specifies whether to use encrypted storage.	true
value	string	The value of the variable.	variable_value
cookie	string	The cookie sent with the HTTP request.	lang=en
diagnosis_mtr	boolean	Specifies whether to enable automatic MTR network diagnostics after a task failure. Valid values: false: does not enable automatic MTR network diagnostics. true: enables automatic MTR network diagnostics.	false
diagnosis_ping	boolean	Specifies whether to enable automatic PING network latency detection after a task failure. Valid values: false: does not enable automatic PING network latency detection. true: enables automatic PING network latency detection.	false
dns_hijack_whitelist	string	The list of DNS hijacking configurations.	www.taobao.com:www.taobao.com.danuoyi.tbcache.com
dns_match_rule	string	The matching rule for DNS. Valid values: IN_DNS: all expected aliases or IP addresses are 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 DNS monitoring.	192.168.XX.XX
dns_type	string	The DNS resolution type. This parameter applies only to DNS monitoring. Valid values: A: the IP address corresponding to the specified hostname or domain name. CNAME: maps multiple domain names to another domain name. NS: specifies the DNS server that resolves the domain name. MX: points the domain name to a mail server address. TXT: the description of the hostname or domain name. The text length is limited to 512 bytes. This type is commonly used for SPF (Sender Policy Framework) records to prevent spam.	A
empty_message	boolean	Specifies whether to allow a WebSocket task to return no message or an empty message. Valid values: false (default): not allowed. true: allowed.	false
enable_packet_capture	boolean	Specifies whether to enable packet capture for the task.	true
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 to not exist on the page.
	string	The list of strings expected to not exist on the page.	unexpected string
expect_value	string	The alias or address to resolve. Note This parameter applies only to DNS monitoring.	dns_server
failure_rate	number	The packet loss rate. Note This parameter applies only to PING monitoring.	0.4
header	string	The HTTP request header.	testKey:testValue
hops	integer	The number of hops for traceroute diagnostics when a PING task fails.	20
host_binding	string	The custom host for HTTP tasks. The format is ip1,ip2:address. You can configure multiple mappings. The left side of the colon is the A record or CNAME that the domain name can be resolved to, separated by commas. The right side of the colon is the domain name.	127.0.0.1:www.aliyun.com
host_binding_type	integer	The mode in which the custom host takes effect. Valid values: 0 (random) and 1 (round-robin). Valid values: 0 : 0 1 : 1	0
http_method	string	The HTTP request method. Valid values: get post head	get
icmp_timeout_millis	integer	The timeout period for a single PING operation using the ICMP protocol. Unit: milliseconds.	3000
ip_network	string	The network type of the task. Valid values: v4, v6, and auto. Default value: v4.	v4
isBase64Encode	string	Specifies whether to decode the password using Base64 before storing it. Valid values: true: decodes the password using Base64 before storing it. false: does not decode the password using Base64 before storing it.	false
match_rule	integer	Specifies whether to include an alert rule. Valid values: 0: yes. 1: no.	1
max_tls_version	string	The maximum TLS version.	tlsv1.3
min_tls_version	string	The minimum TLS version. TLS 1.2 and later are supported by default. TLS 1.0 and TLS 1.1 are disabled. You can change the configuration to re-enable them if needed.	tlsv1.2
password	string	The password for SMTP, POP3, or FTP monitoring.	123****
ping_num	integer	The number of heartbeats for PING monitoring.	29
ping_port	integer	The PING port. Applies to TCP PING.	80
ping_type	string	The PING protocol type. Valid values: icmp tcp udp	icmp
port	integer	The port for TCP, UDP, SMTP, or POP3 monitoring.	110
private_crt_file_name	string	The name of the private certificate file.	cert.pem
protocol	string	The monitoring protocol.	TCP
quic_enabled	boolean	Specifies whether to use the QUIC protocol for browser monitoring. Valid values: true: uses the QUIC protocol. false: does not use the QUIC protocol. 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 HTTP monitoring.	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 matched response content.	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 failure.	0
safe_link	integer	Applies to SMTP tasks. Set to 1 to use a secure connection. Default value: 0.	0
screen_shot	boolean	Specifies whether to enable page screenshots.	false
scroll_end	boolean	For browser monitoring tasks, specifies whether to scroll to the bottom of the page after it opens.	false
server_name	string	The Server Name Indication (SNI).	www.aliyun.com
sse	boolean	Specifies whether to use SSE monitoring.
steps	object
steps	array<object>	The step configurations for multi-step monitoring. Takes effect for multi-step monitoring.
	array<object>	The configuration for a single step in multi-step monitoring.
allow_failure	boolean	Specifies whether to continue to the next step if the current step fails. Default value: false.	true
auto_extract_cookie	boolean	Specifies whether to automatically extract cookies. The Set-Cookie header returned by the HTTP monitoring step is parsed and made available in subsequent monitoring steps. Default value: false.	true
extracted_variables	object
extracted_variables	array<object>	The variable extraction configuration.
	array<object>	The configuration for extracting a single variable.
extracted_type	string	The location from which the variable is extracted. Valid values: 0 (HTTP body) and 1 (HTTP header).	1
field	string	The key in the HTTP header from which the variable is extracted. This option takes effect when the variable location is set to HTTP header.	request_id
name	string	The variable name.	test_variable
parser	object	The variable extraction method settings.
parser_type	string	The extraction mode for the variable. Valid values: 0 (JSON), 1 (XML), and 2 (regular expression).	0
value	string	The variable extraction expression. When the extraction mode is JSON or XML, the expression supports XML format. When the extraction mode is regular expression, the string that matches this value is extracted.	x.testkey.arrayvalue[0].innerkey
is_critical	boolean	Specifies whether a failure in the current step marks the entire monitoring task as failed. Default value: false.	true
name `deprecated`	string	The step name (deprecated).	step1
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 step name.	step1
step_type	string	The monitoring type for the step. Valid values: http ping tcp udp dns smtp pop3 ftp wait The wait type is a wait step.	http
url	string	The URL for a single step in multi-step monitoring.	https://aliyun.com
use_generated_cookie	boolean	Specifies whether to use cookies extracted in previous steps. Default value: false.	true
wait_time_in_secs	integer	The wait time. Unit: seconds.	5
strict_mode	boolean	Indicates whether to allow the loading failures of some page elements. Valid values: false and true.	false
supported_cipher_suits	string	The supported cipher suites.	TLS_AES_256_GCM_SHA384
time_out	integer	The timeout period. Unit: milliseconds.	3
trace_region	string	The deployment region of the target application when integrating with Managed Service for OpenTelemetry.	cn-hangzhou
trace_type	string	The Tracing Analysis protocol used when integrating with Managed Service for OpenTelemetry. Settings: OpenTelemetry Zipkin Jaeger	OpenTelemetry
traffic_hijack_element_blacklist	object
traffic_hijack_element_blacklist	array	When a redirect occurs, if the URL of a 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 a 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 set to 0, no check is performed. Default value: 0.	0
traffic_hijack_element_whitelist	object
traffic_hijack_element_whitelist	array	When a redirect occurs, if the URL of a 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 a resource loaded by the browser does not match any expression in this list, traffic hijacking is considered to have occurred.	www.taobao.com
use_private_crt	boolean	Specifies whether to use a private certificate.
use_ssl	boolean	Specifies whether to use an SSL connection when running a TCP task.	tlsv1.0
username	string	The username for FTP, SMTP, or POP3.	testUser
waitTime_after_completion	integer	The additional wait time after a page is opened in a browser-based detection task.	3
TaskId	string	The ID of the monitoring task.	cc641dff-c19d-45f3-ad0a-818a0c4f****
TaskName	string	The name of the monitoring task.	test123
TaskState	string	The status of the monitoring task. Valid values: 1: enabled. 2: disabled.	1
TaskType	string	The type of the monitoring task. Site monitoring supports the following task types: HTTP(S), PING, TCP, UDP, DNS, SMTP, POP3, and FTP.	HTTP
VpcConfig	object	The VPC configuration of the internal network detection task.
Region	string	The region where the target site of the internal network detection task is located.	cn-beijing
SecurityGroupId	string	The ID of the security group to which the internal network detection task is restricted.	sg-xxxxxx
VpcId	string	The ID of the VPC to which the internal network detection task is attached.	vpc-xxxxxx
VswitchId	string	The ID of the vSwitch to which the internal network detection task is attached.	vsw-xxxxxx
Success	boolean	Indicates whether the operation was successful. Valid values: true: The operation was successful. false: The operation 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": {
        "access_key_id": "testAk",
        "access_key_secret": "testSk",
        "api_action": "example_api",
        "api_version": "2019-01-01",
        "auth_style": "ROA",
        "client_id": "client_id",
        "client_secret": "client_secret",
        "grant_type": "password",
        "password": "test_password",
        "region_id": "cn-hangzhou",
        "scopes": {
          "scopes": [
            "test_operation"
          ]
        },
        "service_name": "example_service_name",
        "session_token": "example_token",
        "token_url": "https://www.example.com",
        "type": "basic",
        "use_cookie_session_key": false,
        "username": "test_username",
        "with_addon_resources": false
      },
      "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",
      "config_variables": {
        "config_variables": [
          {
            "name": "variable_name",
            "secure": true,
            "value": "variable_value"
          }
        ]
      },
      "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,
      "enable_packet_capture": true,
      "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",
      "hops": 20,
      "host_binding": "127.0.0.1:www.aliyun.com",
      "host_binding_type": 0,
      "http_method": "get",
      "icmp_timeout_millis": 3000,
      "ip_network": "v4",
      "isBase64Encode": "false",
      "match_rule": 1,
      "max_tls_version": "tlsv1.3",
      "min_tls_version": "tlsv1.2",
      "password": "123****",
      "ping_num": 29,
      "ping_port": 80,
      "ping_type": "icmp",
      "port": 110,
      "private_crt_file_name": "cert.pem",
      "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,
      "safe_link": 0,
      "screen_shot": false,
      "scroll_end": false,
      "server_name": "www.aliyun.com",
      "sse": false,
      "steps": {
        "steps": [
          {
            "allow_failure": true,
            "auto_extract_cookie": true,
            "extracted_variables": {
              "extracted_variables": [
                {
                  "extracted_type": "1",
                  "field": "request_id",
                  "name": "test_variable",
                  "parser": {
                    "parser_type": "0",
                    "value": "x.testkey.arrayvalue[0].innerkey"
                  }
                }
              ]
            },
            "is_critical": true,
            "name": "step1",
            "option": "{\"enable_operator_dns\": true}",
            "step_name": "step1",
            "step_type": "http",
            "url": "https://aliyun.com",
            "use_generated_cookie": true,
            "wait_time_in_secs": 5
          }
        ]
      },
      "strict_mode": false,
      "supported_cipher_suits": "TLS_AES_256_GCM_SHA384",
      "time_out": 3,
      "trace_region": "cn-hangzhou",
      "trace_type": "OpenTelemetry",
      "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"
        ]
      },
      "use_private_crt": false,
      "use_ssl": true,
      "username": "testUser",
      "waitTime_after_completion": 3
    },
    "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.