UpdateTimingSyntheticTask - Application Real-Time Monitoring Service

Updates a scheduled synthetic test task.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
arms:UpdateTimingSyntheticTask	Write	SyntheticTask acs:arms:{#regionId}:{#accountId}:synthetictask/{#TaskId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
TaskId	string	No	The ID of the synthetic monitoring task.	5308a2691f59422c8c3b7aeccxxxxxxx
Name	string	No	The name of the task.	AlibabaCloud DNS Task
TaskType	integer	No	The type of the task. Valid values: 1: ICMP. 2: TCP. 3: DNS. 4: HTTP. 5: website speed measurement. 6: file download.	1
MonitorConf	object	No	The monitoring configurations.
NetICMP	object	No	The ICMP synthetic test parameters.
TargetUrl	string	No	The destination host IP address or domain name. Port numbers, protocol headers, or request paths are not supported.	www.aliyun.com
Interval	long	No	The interval at which ICMP packets are sent. Unit: milliseconds. Minimum value: 200. Maximum value: 10000.	300
PackageNum	integer	No	The number of ICMP packets that are sent. Minimum value: 1. Maximum value: 50. Default value: 4.	4
PackageSize	integer	No	The size of each ICMP packet. Unit: bytes. Valid values: 32, 64, 128, 256, 512, 1024.	32
SplitPackage	boolean	No	Specifies whether to split ICMP packets. Default value: true.	true
Timeout	long	No	The timeout period for the TCP synthetic test. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 20000.	5000
TracertEnable	boolean	No	Specifies whether to enable the tracert command. Default value: true.	true
TracertNumMax	integer	No	The maximum number of hops for tracert. Minimum value: 1. Maximum value: 128. Default value: 64.	20
TracertTimeout	long	No	The timeout period of tracert. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 60000.	60000
NetTCP	object	No	The TCP synthetic tests parameters. This parameter is required if the TaskType parameter is set to 2.
TargetUrl	string	No	The destination host IP address.	127.0.0.1:8888
ConnectTimes	integer	No	The number of TCP connections that are established in a test. Minimum value: 1. Maximum value: 16. Default value: 4.	4
Interval	long	No	The interval at which TCP connections are established. Unit: milliseconds. Minimum value: 200. Maximum value: 10000. Default value: 200.	300
Timeout	long	No	The timeout period for the TCP synthetic test. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 20000.	1000
TracertEnable	boolean	No	Specifies whether to enable the tracert command. Default value: true.	true
TracertNumMax	integer	No	The maximum number of hops for tracert. Minimum value: 1. Maximum value: 128. Default value: 20.	20
TracertTimeout	long	No	The timeout period of tracert. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 60000.	1000
NetDNS	object	No	The DNS synthetic test parameters.
TargetUrl	string	No	The destination domain name.	www.aliyun.com
Dig	integer	No	Specifies whether to use dig to display the data. 0: No. 1: Yes.	0
DnsServerIpType	integer	No	The IP version of the DNS server. 0: IPv4. 1: IPv6. 2: A version is automatically selected. Default value: 0.	0
NsServer	string	No	The IP address of the DNS server. Default value: 114.114.114.114.	114.114.114.114
QueryMethod	integer	No	The DNS query. 0: recursive, 1: iterative. Default value: 0.	0
Timeout	long	No	The timeout period for the DNS synthetic test. Unit: milliseconds. The minimum value is 1000 and the maximum value is 45000. Default value: 5000.	1000
ApiHTTP	object	No	The HTTP(S) synthetic test parameters.
TargetUrl	string	No	The URL or request path for synthetic monitoring.	https://********
Method	string	No	The request method. POST GET	POST
RequestHeaders	object	No	The custom header field.
	string	No	Format: JSON map.	{ "key1": "value1", "key2": "value2" }
RequestBody	object	No	The HTTP request body.
Content	string	No	The content of the request body. Format: JSON string. The parameter is required if the type parameter is set to text/plain, application/json, application/xml, or text/html. Format: JSON string.	{ "key1": "value1", "key2": "value2" }
Type	string	No	The type of the request body. Valid values: text/plain, application/json, application/x-www-form-urlencoded, multipart/form-data, application/xml, and text/html.	application/json
ConnectTimeout	long	No	The connection timeout period. Unit: milliseconds. Default value: 5000. Minimum value: 1000. Maximum value: 300000.	5000
Timeout	long	No	The timeout period. Unit: milliseconds. Default value: 10000. Minimum value: 1000. Maximum value: 300000.	5000
Website	object	No	The website-speed measurement parameters.
TargetUrl	string	No	The destination URL.	https://********
AutomaticScrolling	integer	No	Specifies whether to automatically scroll up and down the screen to load a page. 0: No. 1: Yes. Default value: 0.	0
CustomHeader	integer	No	Specifies whether to create a custom header. 0: No. 1: The first packet is modified. 2: All packets are modified. Default value: 0.	0
CustomHeaderContent	object	No	The custom header. Format: JSON map.
	string	No	JSON Map	{ "key1": "value1", "key2": "value2" }
DisableCache	integer	No	Specifies whether to disable the cache. 0: No. 1: Yes. Default value: 1.	0
DisableCompression	integer	No	Specifies whether to accept compressed files based on the HTTP Accept-Encoding request header. 0: No. 1: Yes. Default value: 0.	0
FilterInvalidIP	integer	No	Specifies whether to filter invalid IP addresses. 1: No 0: Yes	0
IgnoreCertificateError	integer	No	Specifies whether to ignore SSL certificate errors during browsing. 0: No. 1: Yes. Default value: 1.	0
MonitorTimeout	long	No	The monitoring timeout period. Unit: milliseconds. Minimum value: 5000. Maximum value: 300000. Default value: 40000.	20000
Redirection	integer	No	Specifies whether to continue browsing after redirection. 0: No, 1:Yes. Default value: 1.	0
SlowElementThreshold	long	No	The time threshold that is used to define a slow element. Unit: milliseconds. Default value: 5000. Minimum value: 1. Maximum value: 300000.	5000
WaitCompletionTime	long	No	The maximum waiting time. Unit: milliseconds. Default value: 5000. Minimum value: 5000. Maximum value: 300000.	5000
FileDownload	object	No	The file download parameters.
TargetUrl	string	No	The file download URL.	https://img.alicdn.com/tfs/TB13DzOjXP7gK0jSZFjXXc5aXXa-212-48.png
DownloadKernel	integer	No	The kernel type. 1: curl 0: WinInet	0
QuickProtocol	integer	No	The QUIC protocol type. 1: http1 2: http2 3: http3	1
ConnectionTimeout	long	No	The connection timeout period. Unit: milliseconds. Minimum value: 1000. Maximum value: 120000. Default value: 5000.	5000
MonitorTimeout	long	No	The monitoring timeout period. Unit: milliseconds. Minimum value: 1000. Maximum value: 120000. Default value: 60000.	60000
CustomHeaderContent	object	No	The content of the custom request header.
	string	No	Format: JSON map.	{ "key1": "value1", "key2": "value2" }
IgnoreCertificateStatusError	integer	No	Specifies whether to ignore certificate status errors. 0: No. 1: Yes. Default value: 1.	0
IgnoreCertificateUntrustworthyError	integer	No	Specifies whether to ignore certificate incredibility. 0: No. 1: Yes. Default value: 1.	0
IgnoreInvalidHostError	integer	No	Specifies whether to ignore host invalidity. 0: No. 1: Yes. Default value: 1.	0
Redirection	integer	No	Specifies whether to support redirection. 0: No. 1: Yes. Default value: 1.	0
TransmissionSize	long	No	The maximum file size of a single transfer. Unit: KB. Minimum value: 1. Maximum value: 20480. Valid values: 2048.	2048
IgnoreCertificateCanceledError	integer	No	Specifies whether to ignore certificate revocation errors. 0: No. 1: Yes. Default value: 1.	0
IgnoreCertificateAuthError	integer	No	Specifies whether to ignore CA certificate authentication errors. 0: No. 1: Yes. Default value: 1.	0
IgnoreCertificateOutOfDateError	integer	No	Specifies whether to ignore certificate invalidity. 0: No. 1: Yes. Default value: 1.	0
IgnoreCertificateUsingError	integer	No	Specifies whether to ignore certificate usage errors. 0: No. 1: Yes. Default value: 1.	0
MonitorCategory	integer	No	The detection point type. 1: PC. 2: mobile device.	1
Monitors	object []	No	The list of monitoring points.
CityCode	string	No	The city code.	100001
OperatorCode	string	No	The carrier code.	1
ClientType	integer	No	The client type of the monitoring point. Valid values: 1: data center. 2: Internet. 3: mobile device. 4: ECS instance.	4
Frequency	string	No	The detection frequency. Valid values: 1m, 5m, 10m, 15m, 20m, 30m, 1h, 2h, 3h, 4h, 6h, 8h, 12h, and 24h.	5m
CustomPeriod	object	No	The custom cycle.
EndHour	integer	No	The hour at which the test ends. Valid values: 0 to 24.	22
StartHour	integer	No	The hour at which the test starts. Valid values: 0 to 24.	14
CommonSetting	object	No	The general settings.
CustomHost	object	No	The custom host.
Hosts	object []	No	The list of hosts.
Domain	string	No	The domain name.	www.aliyun.com
IpType	integer	No	The IP version. Valid values: 0: A version is automatically selected. 1: IPv4 2: IPv6	0
Ips	array	No	The list of IP addresses.
	string	No	The IP address.	127.0.0.1
SelectType	integer	No	The selection mode. 0: Random. 1: Polling.	0
IpType	integer	No	The IP version. Valid values: 0: A version is automatically selected. 1: IPv4 2: IPv6	0
MonitorSamples	integer	No	Specifies whether to evenly distribute monitoring samples. Valid values: 0: No 1: Yes	0
AvailableAssertions	object []	No	The list of assertions.
Type	string	No	The assertion type. Valid values: HttpResCode, HttpResHead, HttpResBody, HttpResBodyJson, HttpResponseTime, IcmpPackLoss (packet loss rate), IcmpPackMaxLatency (maximum packet latency), IcmpPackAvgLatency (average packet latency), TraceRouteHops (number of hops), DnsARecord (A record), DnsCName (CNAME), websiteTTFB (time to first packet), websiteTTLB (time to last packet), websiteFST (first paint time), websiteFFST (first meaningful paint), websiteOnload (full loaded time). For more information, see the following description.	TraceRouteHops
Target	string	No	The check target. If you set the type parameter to HttpResCode, HttpResBody, or HttpResponseTime, you do not need to set the target parameter. If you set the type parameter to HttpResHead, you must specify the key in the header. If you set the type parameter to HttpResBodyJson, use jsonPath.	HttpResponseTime
Operator	string	No	The condition. gt: greater than. gte: greater than or equal to. lt: less than. lte: less than or equal to. eq: equal to. neq: not equal to. ctn: contain. nctn: does not contain. exist: exist. n_exist: does not exist. belong: belong to. n_belong: does not belong to. reg_match: regular expression.	eq
Expect	string	No	The expected value.	200
ResourceGroupId	string	No	The resource group ID.	rg-acfmxyexli2****
Tags	object []	No	The list of tags.
Key	string	No	The key of the tag.	key
Value	string	No	The value of the tag.	value

Assertion description:

HTTP synthetic tests:

● If the type parameter is set to HttpResCode, the Operator parameter supports the following values: eq, neq, gt, gte, lt, lte, belong, and n_belong.

● If the type parameter is set to HttpResHead, the Operator parameter supports all values.

● If the type parameter is set to HttpResBody, the Operator parameter supports all values.

● If the type parameter is set to HttpResBodyJson, the Operator parameter supports all values.

● If the type parameter is set to HttpResponseTime, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.

ICMP synthetic tests:

● If the type parameter is set to IcmpPackLoss, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.

● If the type parameter is set to IcmpPackMaxLatency, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.

● If the type parameter is set to IcmpPackAvgLatency, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.

● If the type parameter is set to TraceRouteHops, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.

DNS synthetic tests:

● If the type parameter is set to DnsARecord, the Operator parameter supports the following values: eq, ctn, nctn, reg_match, not_reg_match. A records can be selectively displayed.

● If the type parameter is set to DnsCName, the Operator parameter supports the following values: eq, ctn, nctn, reg_match, not_reg_match. CNAME records can be selectively displayed.

Website speed measurement:

● If the type parameter is set to websiteTTFB, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.

● If the type parameter is set to websiteTTLB, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.

● If the type parameter is set to websiteFST, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.

● If the type parameter is set to websiteFFST, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.

● If the type parameter is set to websiteOnload, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	F7781D4A-2818-41E7-B7BB-79D809E9****
Success	boolean	Indicates whether the request was successful. Valid values: `true` `false`	true
Code	long	The status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.	200
Message	string	The message returned.	success
Data	object	The struct returned.
TaskId	string	The task ID.	1eeb351722c84e05b52c82fd0dc9953e

Examples

Sample success responses

JSONformat

{
  "RequestId": "F7781D4A-2818-41E7-B7BB-79D809E9****",
  "Success": true,
  "Code": 200,
  "Message": "success",
  "Data": {
    "TaskId": "1eeb351722c84e05b52c82fd0dc9953e"
  }
}

Error codes

HTTP status code	Error code	Error message
400	ParameterMissing	%s
400	ParameterIllegal	%s
400	TaskQuotaLimit	%s
400	ParameterRegionIllegal	%s
400	DuplicateTagKey	Param tagKey is duplicate.
400	TagNumOUT	the number of tag is out .
400	NoPermissionUSER	user no permission
403	RAMNotAuthorize	%s
403	STSNotAuthorize	%s
403	IllegalUserAccess	%s
403	APINotAuthorize	%s
403	CommercialStatusException	%s
403	SyntheticTrailExpired	%s
403	SyntheticInDebt	%s
403	SyntheticDailyTimesExhausted	%s
403	SyntheticDailyLimit	%s
403	INNER_PROHIBIT

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2024-04-12

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 403

2024-03-14

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 403

2024-03-01

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 403

2024-02-23

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 403

2024-01-05

The Error code has changed. The request parameters of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 403
Input Parameters	The request parameters of the API has changed.
	delete Input Parameters: TaskType
	delete Input Parameters: MonitorCategory

2023-11-07

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 403

2023-10-26

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 403 change
	delete Error Codes: 400

2023-09-08

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 403 change
	delete Error Codes: 400