接口说明
云拨测目前仅在杭州 region 提供服务,使用 SDK 或 OpenAPI 时请选择杭州 region 对应的服务接入点。
流控信息
授权信息
当前云产品暂无权限信息透出。
请求参数
字段名称 | 字段详情 |
---|---|
RegionIdstring | 地域 ID,当前只支持 cn-hangzhou。 示例值:cn-hangzhou |
SyntheticTypeinteger<int32> | 拨测类型,必填,即时拨测:1,定时拨测:2。 示例值:1 |
Categorystring | 结果分类,必填,写死:SYNTHETIC。 示例值:SYNTHETIC |
Detailstring | 拨测结果内容,必填,获取不同类型的拨测结果传不同的值:展开详情 示例值:ICMP_LIST参考取值来源: GetSyntheticTaskDetail |
Filtersmap<string> | 筛选条件,必填。展开详情 |
AdvancedFiltersarray<object> | 筛选条件数组,必填。展开详情 |
ExactFiltersarray<object> | 保留字段。 子级条数 <= 100 |
StartTimeinteger<int64> | 查询起始时间的时间戳,必填,精确到毫秒。 注意
该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。 示例值:1684110343127 |
EndTimeinteger<int64> | 查询结束时间的时间戳,必填,精确到毫秒。 注意
该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。 示例值:1684480557772 |
OrderBystring | 排序字段,仅支持:timestamp(拨测发起时间)。 示例值:timestamp |
Orderstring | 排序标准。取值:展开详情 示例值:DESC |
Pageinteger<int32> | 查询页码,从 1 开始。 示例值:1 |
PageSizeinteger<int32> | 分页大小。 示例值: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 字段。
返回参数
字段名称 | 字段详情 |
---|---|
RequestIdstring | Id of the request 示例值:70675725-8F11-4817-8106-CFE0AD71**** |
Codeinteger<int64> | 状态码。200 表示成功。 注意
请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。 示例值:200 |
Messagestring | 错误信息。 示例值:null |
Dataobject | 返回结构体。 |