Obtains the results of one or more synthetic tests.
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:ListSyntheticDetail | list |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | No | The ID of the region. Set the value to cn-hangzhou. | cn-hangzhou |
| SyntheticType | integer | No | The type of the synthetic test. Valid values: 1 and 2. 1 represents an immediate test, and 2 represents a scheduled test. | 1 |
| Category | string | No | The type of the results. Set the value to SYNTHETIC. | SYNTHETIC |
| Detail | string | No | The type of the list that contains the results. This parameter is required. Valid values:
| ICMP_LIST |
| Filters | object | No | The filter condition. This parameter is required.
| |
| string | No | The filter condition. | {"taskId":"xxxaaabbbcccdddeeefffggg"} | |
| AdvancedFilters | array<object> | No | An array of filter conditions. This parameter is required.
| |
| object | No | An array of filter conditions. | ||
| Key | string | No | The filter condition. The taskType and dataId fields are supported.
| taskType |
| OpType | string | No | The type of the filter condition. Valid values: eq and in. eq: equal to. in: include. | eq |
| Value | any | No | The value of the filter condition. The type of the task. Valid values: 1: ICMP 2: TCP 3: DNS 4: HTTP 5: website speed measurement 6: file download | 1 |
| ExactFilters | array<object> | No | A reserved field. | |
| object | No | |||
| Key | string | No | A reserved field. | null |
| OpType | string | No | A reserved field. | null |
| Value | any | No | A reserved field. | null |
| StartTime | long | No | The timestamp of the start time of the query. Unit: milliseconds. | 1684110343127 |
| EndTime | long | No | The timestamp of the end time of the query. Unit: milliseconds. | 1684480557772 |
| OrderBy | string | No | The field based on which results are sorted. Set the value to timestamp. | timestamp |
| Order | string | No | The order in which results are sorted. Valid values:
| DESC |
| Page | integer | No | The page number. Pages start from page 1. | 1 |
| PageSize | integer | No | The number of entries per page. | 20 |
The query of synthetic test results contains two steps. Take a ping synthetic test as an example.
Step 1: Query a result list:
{"SyntheticType":1,"RegionId":"cn-hangzhou","Category":"SYNTHETIC","Detail":"ICMP_LIST","Filters":{"taskId":"xxxx"},"AdvancedFilters":[{"Key":"taskType","OpType":"in","Value":[1]}],"StartTime":1710124284000,"EndTime":1710125544000,"Page":1,"PageSize":999}
Step 2: Query the result details:
{"RegionId":"cn-hangzhou","StartTime":1710115743153,"EndTime":1710137343153,"SyntheticType":2,"Category":"SYNTHETIC","Detail":"ICMP_LIST","AdvancedFilters":[{"Key":"dataId","OpType":"eq","Value":"$dataId"}],"Page":1,"PageSize":999,"Filters":{"dataId":"$dataId"}}
Replace $dataId with the dataId field in each record that is returned in Step 1.
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "70675725-8F11-4817-8106-CFE0AD71****",
"Code": 200,
"Message": "null",
"Data": {
"Items": [
{
"key": "{\n \"requestId\": \"9A82BD90-4A42-5E25-9DA1-D85A2D4AA696\",\n \"code\": \"200\",\n \"message\": null,\n \"action\": null,\n \"apiName\": null,\n \"extendedCode\": null,\n \"bizCode\": null,\n \"httpStatusCode\": \"200\",\n \"accessDeniedDetail\": null,\n \"data\": {\n \"RequestId\": \"9A82BD90-4A42-5E25-9DA1-D85A2D4xxxxx\",\n \"Data\": {\n \"PageSize\": 999,\n \"Total\": 1,\n \"Page\": 1,\n \"Items\": [\n {\n \"__time__\": 1710115743,\n \"ipIsp\": \"aliyun\",\n \"targetCity\": \"\",\n \"ipCity\": \"Virginia\",\n \"__source__\": \"\",\n \"resultCode\": \"2400\",\n \"icmpLossRate\": \"20\",\n \"ipCountry\": \"USA\",\n \"tracertHops\": \"0\",\n \"url\": \"www.aliyun.com\",\n \"targetIp\": \"47.88.XX.XX\",\n \"targetOperator\": \"aliyun\",\n \"clientType\": \"4\",\n \"dataId\": \"377a04e1cd5a4adc8fb0f249666xxxxx\",\n \"tracertTime\": \"null\",\n \"clientLastIp\": \"21.0.XX.XX\",\n \"errName\": \"null\",\n \"ipRegion\": \"USA\",\n \"taskName\": \"Aliyun Dial-up Test Point\",\n \"icmpTime\": \"229\",\n \"timestamp\": \"1710137152606\"\n }\n ]\n },\n \"Code\": 200\n },\n \"successResponse\": true\n}"
}
],
"Total": 12,
"Page": 1,
"PageSize": 10,
"TaskCreateTime": 0
}
}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 |
|---|