1. 接口描述
接口请求域名: rum.tencentcloudapi.com 。
返回一个拨测批次的探测结果和路由追踪。Probes 的 Region、Operator 是目标 IP 归属。逐跳归属同时写在 Probes.MTR.Hops 和顶层 MTR.Hops。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeTDEMDialExecutionDetail。 |
| Version | 是 | String | 公共参数,本接口取值:2021-06-22。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| AppId | 是 | String | 应用 ID 示例值:5 |
| StartTime | 是 | Integer | 开始时间,毫秒时间戳 示例值:1788852300000 |
| EndTime | 是 | Integer | 结束时间,毫秒时间戳,必须大于 StartTime 示例值:1791858780000 |
| TaskId | 是 | String | 任务 ID。不传表示不过滤。 示例值:1 |
| TaskSessionId | 是 | String | 拨测批次 ID 示例值:6b37f3fe-0b2c-43c5-8bc1-a8cad1a60202 |
| Platform | 否 | String | 客户端平台。不传表示不过滤。 示例值:android |
| AppVersion | 否 | String | 应用版本。不传表示不过滤。 示例值:1.0.0 |
| Device | 否 | String | 设备机型,对应 device_type。不传表示不过滤。 示例值:sdk_gphone64_arm64 |
| NetType | 否 | String | 网络类型,对应 network_type。不传表示不过滤。 示例值:wifi |
| Operator | 否 | String | 客户端运营商,对应 isp。不传表示不过滤。不是目标 IP 运营商。 示例值:电信 |
| ClientRegion | 否 | String | 客户端地区,对应 province。云 API 公共参数已占用 Region,筛选入参名为 ClientRegion。不传表示不过滤。不是目标 IP 地区。 示例值:广东 |
| TargetIp | 否 | String | 目标 IP。不传表示不过滤。 示例值:183.2.172.177 |
| Environment | 否 | String | 环境。可选。不传表示不过滤。 示例值:prod |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 任务 ID 示例值:1 |
| TaskName | String | 任务名称 示例值:capi-selftest-0930-mod |
| TaskSessionId | String | 拨测批次 ID 示例值:6b37f3fe-0b2c-43c5-8bc1-a8cad1a60202 |
| StartTime | Integer | 批次开始时间,毫秒时间戳 示例值:1791444282154 |
| SessionId | String | 所属用户会话 ID 示例值:bbd4851f-d07b-4de0-ad5a-3d04f68e3f84 |
| Success | Boolean | 本批次是否全部探测成功 示例值:true |
| AvgDuration | Float | 平均时延,单位毫秒 示例值:132.1 |
| Platform | String | 客户端平台 示例值:android |
| AppVersion | String | 应用版本 示例值:1.0.0 |
| Device | String | 设备机型 示例值:sdk_gphone64_arm64 |
| NetType | String | 网络类型 示例值:wifi |
| Operator | String | 客户端运营商 示例值:电信 |
| Region | String | 客户端地区 示例值:广东 |
| TargetIps | Array of String | 本批次目标 IP 示例值:["183.2.172.177"] |
| Probes | Array of DialProbe | 每个目标的探测结果 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询拨测批次详情
按应用、任务、批次和时间窗查询这一批探测的连通性与路由追踪。
输入示例
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTDEMDialExecutionDetail
<公共请求参数>
{
"AppId": "5",
"StartTime": 1790092800000,
"EndTime": 1790784000000,
"TaskId": "1",
"TaskSessionId": "selftest-no-exec"
}
输出示例
{
"Response": {
"AppVersion": "",
"AvgDuration": 0,
"Device": "",
"NetType": "",
"Operator": "",
"Platform": "",
"Probes": [],
"Region": "",
"SessionId": "",
"StartTime": 0,
"Success": false,
"TargetIps": [],
"TaskId": "1",
"TaskName": "capi-selftest-0930-mod",
"TaskSessionId": "selftest-no-exec",
"RequestId": "fa3f3918-e88d-4327-b1fb-0818de977b79"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| ResourceNotFound | 资源不存在。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |