Queries scheduled synthetic monitoring tasks.
Debugging
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 Resourcesis 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:ListTimingSyntheticTasks | list |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | No | The region ID. | cn-hangzhou |
| Search | object | No | The search keyword. | |
| TaskTypes | array | No | The task types. | |
| integer | No | The task type. 1: ICMP. 2: TCP. 3: DNS. 4: HTTP. 5: website speed. 6: file download. | 1 | |
| TaskIds | array | No | The task IDs. | |
| string | No | The task ID. | 181248 | |
| Name | string | No | The task name. | AlibabaCloud DNS Task |
| Status | string | No | The task status. CREATING: The task is being created. RUNNING: The task is running. PARTIAL_RUNNING: The task is partially running. STOP: The task is stopped. LIMIT_STOP: The task is stopped due to quota limit. EXCEPTION: The task is abnormal. DELETE: The task is deleted. DELETE_EXCEPTION: An exception occurs while deleting the task. | CREATING |
| OrderField | string | No | The condition by which tasks are sorted. You can sort tasks by gmtCreate, gmtModified, status, or monitorCount. | status |
| Order | integer | No | The order by which tasks are sorted. 1: ascending order. -1: descending order. | 1 |
| Page | integer | No | The page number. This parameter is required. | 1 |
| PageSize | integer | No | The number of entries per page. This parameter is required. | 10 |
| ResourceGroupId | string | No | The ID of the resource group. | rg-acfmxyexli2**** |
| Tags | array<object> | No | The tags. | |
| object | No | |||
| Key | string | No | The tag key. | mark |
| Value | string | No | The tag value. | value1111 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "730E90FE-996A-5638-99F3-4F0F9038CC6C",
"Code": 200,
"Message": "success",
"Data": {
"Items": [
{
"TaskId": "5308a2691f59422c8c3b7aeccec9cd3b",
"RegionId": "cn-hangzhou",
"Name": "AlibabaCloud DNS Task",
"TaskType": 1,
"Url": "https://www.example.com",
"MonitorCategory": 1,
"Frequency": "1m",
"MonitorNum": "10",
"Status": "RUNNING",
"GmtCreate": "1671454758000",
"GmtModified": "1673085633000",
"ResourceGroupId": "rg-aekzgwtq5vxxxxx",
"CommonSetting": {
"CustomHost": {
"Hosts": [
{
"Domain": "www.aliyun.com",
"IpType": 0,
"Ips": [
"39.104.85.210"
]
}
],
"SelectType": 0
},
"IpType": 0,
"MonitorSamples": 0,
"IsOpenTrace": false,
"TraceClientType": 1,
"XtraceRegion": "cn-hangzhou",
"CustomVPCSetting": {
"RegionId": "cn-zhangjiakou",
"VpcId": "vpc-2zehbd4dfzahxxxxxxx",
"VSwitchId": "vsw-bp1bcmj81kxxxxxxx",
"SecureGroupId": "sg-xxxxxxxxxxxxxx"
},
"CustomPrometheusSetting": {
"PrometheusLabels": {
"key": "Reserved field\n"
},
"PrometheusClusterId": "Reserved field\n",
"PrometheusClusterRegion": "Reserved field\n"
}
},
"Tags": [
{
"Key": "key",
"Value": "value"
}
]
}
],
"Total": 100,
"Page": 1,
"PageSize": 10
}
}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 |
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. The response structure of the API has changed | View Change Details |