获取拨测结果。
接口说明
云拨测目前仅在杭州 region 提供服务，使用 SDK 或 OpenAPI 时请选择杭州 region 对应的服务接入点。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| arms:ListSyntheticDetail | List |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 否 | 地域 ID，当前只支持 cn-hangzhou。 | cn-hangzhou |
| SyntheticType | integer | 否 | 拨测类型，必填，即时拨测：1，定时拨测：2。 | 1 |
| Category | string | 否 | 结果分类，必填，写死：SYNTHETIC。 | SYNTHETIC |
| Detail | string | 否 | 拨测结果内容，必填，获取不同类型的拨测结果传不同的值： PING 列表：ICMP_LIST; TCP 列表: TCP_LIST; DNS 列表: DNS_LIST; HTTP(s)列表: HTTP_LIST; 网站测速列表：WEBSITE_LIST; 文件下载列表：DOWNLOAD_LIST; 拨测结果明细：ALL | ICMP_LIST |
| Filters | object | 否 | 筛选条件，必填，查任务拨测结果列表：{"taskId":"${taskId}"} ，查任务拨测结果详情：{"taskId":"${taskId}","dataId":"${dataId}"} | |
| string | 否 | 筛选条件。 | {"taskId":"xxxaaabbbcccdddeeefffggg"} | |
| AdvancedFilters | object [] | 否 | 筛选条件数组，必填，查询拨测结果列表时，填：[{"Key":"taskType","OpType":"in","Value":[任务类型]}]；查询拨测结果详情时，[{"Key":"dataId","OpType":"eq","Value":"dataId"}] ，dataId 为查任务拨测结果列表返回值的 dataId 字段。 | |
| Key | string | 否 | 筛选条件，支持 taskType 和 dataId 字段，查询拨测结果列表时，填 taskType，查询拨测结果详情时，填 dataId。 | taskType |
| OpType | string | 否 | 筛选类型，支持 eq（等于）和 in（包含）。 | eq |
| Value | any | 否 | 筛选条件的 value。 任务类型： 1：ICMP； 2：TCP； 3：DNS； 4：HTTP； 5：网站测速； 6：文件下载。 | 1 |
| ExactFilters | object [] | 否 | 保留字段。 | |
| Key | string | 否 | 保留字段。 | 保留字段。 |
| OpType | string | 否 | 保留字段。 | 保留字段。 |
| Value | any | 否 | 保留字段。 | 保留字段。 |
| StartTime | long | 否 | 查询起始时间的时间戳，必填，精确到毫秒。 | 1684110343127 |
| EndTime | long | 否 | 查询结束时间的时间戳，必填，精确到毫秒。 | 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 字段。
返回参数
示例
正常返回示例
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.198.68\",\n \"targetOperator\": \"阿里云\",\n \"clientType\": \"4\",\n \"dataId\": \"377a04e1cd5a4adc8fb0f249666xxxxx\",\n \"tracertTime\": \"null\",\n \"clientLastIp\": \"21.0.9.111\",\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 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|