获取拨测结果。
接口说明
云拨测目前仅在杭州 region 提供服务，使用 SDK 或 OpenAPI 时请选择杭州 region 对应的服务接入点。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
否 |
地域 ID，当前只支持 cn-hangzhou。 |
cn-hangzhou |
| SyntheticType |
integer |
否 |
拨测类型，必填，即时拨测：1，定时拨测：2。 |
1 |
| Category |
string |
否 |
结果分类，必填，写死：SYNTHETIC。 |
SYNTHETIC |
| Detail |
string |
否 |
拨测结果内容，必填，获取不同类型的拨测结果传不同的值：
|
ICMP_LIST |
| Filters |
object |
否 |
筛选条件，必填。
|
|
|
string |
否 |
筛选条件。 |
{"taskId":"xxxaaabbbcccdddeeefffggg"} |
|
| AdvancedFilters |
array<object> |
否 |
筛选条件数组，必填。
|
|
|
object |
否 |
筛选条件数组。 |
||
| Key |
string |
否 |
筛选条件，支持 taskType 和 dataId 字段。
|
taskType |
| OpType |
string |
否 |
筛选类型，支持 eq（等于）和 in（包含）。 |
eq |
| Value |
any |
否 |
筛选条件的 value。 任务类型： 1：ICMP； 2：TCP； 3：DNS； 4：HTTP； 5：网站测速； 6：文件下载。 |
1 |
| ExactFilters |
array<object> |
否 |
保留字段。 |
|
|
object |
否 |
保留字段。 |
||
| Key |
string |
否 |
保留字段。 |
保留字段。 |
| OpType |
string |
否 |
保留字段。 |
保留字段。 |
| Value |
any |
否 |
保留字段。 |
保留字段。 |
| StartTime |
integer |
否 |
查询起始时间的时间戳，必填，精确到毫秒。 |
1684110343127 |
| EndTime |
integer |
否 |
查询结束时间的时间戳，必填，精确到毫秒。 |
1684480557772 |
| OrderBy |
string |
否 |
排序字段，仅支持：timestamp（拨测发起时间）。 |
timestamp |
| Order |
string |
否 |
排序标准。取值：
|
DESC |
| Page |
integer |
否 |
查询页码，从 1 开始。 |
1 |
| PageSize |
integer |
否 |
分页大小。 |
20 |
对拨测结果的查询一般分为两步，以查询 PING 类型任务的拨测结果为例。
第一步：查询结果列表：
{"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}
第二步：查询结果详情：
{"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"}}
其中，$dataId 替换成第一步查询拨测结果列表返回值的每一个记录中的 dataId 字段。
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回结果。 |
||
| RequestId |
string |
Id of the request |
70675725-8F11-4817-8106-CFE0AD71**** |
| Code |
integer |
状态码。200 表示成功。 |
200 |
| Message |
string |
错误信息。 |
null |
| Data |
object |
返回结构体。 |
|
| Items |
array<object> |
拨测结果列表。 |
|
|
object |
拨测结果列表。 |
||
|
any |
拨测结果列表记录或拨测详情记录。 |
{ "requestId": "9A82BD90-4A42-5E25-9DA1-D85A2D4AA696", "code": "200", "message": null, "action": null, "apiName": null, "extendedCode": null, "bizCode": null, "httpStatusCode": "200", "accessDeniedDetail": null, "data": { "RequestId": "9A82BD90-4A42-5E25-9DA1-D85A2D4xxxxx", "Data": { "PageSize": 999, "Total": 1, "Page": 1, "Items": [ { "__time__": 1710115743, "ipIsp": "阿里云", "targetCity": "", "ipCity": "弗吉尼亚", "__source__": "", "resultCode": "2400", "icmpLossRate": "20", "ipCountry": "美国", "tracertHops": "0", "url": "www.aliyun.com", "targetIp": "47.88.XX.XX", "targetOperator": "阿里云", "clientType": "4", "dataId": "377a04e1cd5a4adc8fb0f249666xxxxx", "tracertTime": "null", "clientLastIp": "21.0.XX.XX", "errName": "null", "ipRegion": "美国", "taskName": "阿里云拨测点", "icmpTime": "229", "timestamp": "1710137152606" } ] }, "Code": 200 }, "successResponse": true } |
|
| Total |
integer |
数据总条数。 |
12 |
| Page |
integer |
当前页数。 |
1 |
| PageSize |
integer |
分页大小。 |
10 |
| TaskCreateTime |
integer |
保留字段。 |
保留字段。 |
示例
正常返回示例
JSON格式
{
"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\": \"阿里云\",\n \"targetCity\": \"\",\n \"ipCity\": \"弗吉尼亚\",\n \"__source__\": \"\",\n \"resultCode\": \"2400\",\n \"icmpLossRate\": \"20\",\n \"ipCountry\": \"美国\",\n \"tracertHops\": \"0\",\n \"url\": \"www.aliyun.com\",\n \"targetIp\": \"47.88.XX.XX\",\n \"targetOperator\": \"阿里云\",\n \"clientType\": \"4\",\n \"dataId\": \"377a04e1cd5a4adc8fb0f249666xxxxx\",\n \"tracertTime\": \"null\",\n \"clientLastIp\": \"21.0.XX.XX\",\n \"errName\": \"null\",\n \"ipRegion\": \"美国\",\n \"taskName\": \"阿里云拨测点\",\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
}
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 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 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。