1. 接口描述
接口请求域名： cat.tencentcloudapi.com 。
根据时间范围、任务ID、运营商等条件查询单次拨测详情数据
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDetailedSingleProbeData。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-09。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| BeginTime | 是 | Integer | 开始时间戳（毫秒级） 示例值：1000000000 |
| EndTime | 是 | Integer | 结束时间戳（毫秒级） 示例值：1000000000 |
| TaskType | 是 | String | 任务类型 AnalyzeTaskType_Network：网络质量 AnalyzeTaskType_Browse：页面性能 AnalyzeTaskType_UploadDownload：文件传输（含文件上传、文件下载） AnalyzeTaskType_Transport：端口性能 AnalyzeTaskType_MediaStream：音视频体验 示例值：AnalyzeTaskType_UploadDownload |
| SortField | 是 | String | 待排序字段 可以填写 ProbeTime 拨测时间排序 也可填写SelectedFields 中的选中字段 示例值：ProbeTime |
| Ascending | 是 | Boolean | true表示升序 示例值：true |
| SelectedFields.N | 是 | Array of String | 选中字段，如ProbeTime、TransferTime、TransferSize等。 示例值：[ProbeTime] |
| Offset | 是 | Integer | 起始取数位置 示例值：0 |
| Limit | 是 | Integer | 取数数量 示例值：10 |
| TaskID.N | 否 | Array of String | 任务ID 示例值：[task_fasdfds] |
| Operators.N | 否 | Array of String | 拨测点运营商 这里实际按拨测结果中的运营商来填写即可 电信：中国电信 移动：中国移动 联通：中国联通 示例值：[电信] |
| Districts.N | 否 | Array of String | 拨测点地区 这里实际按拨测结果中的地区来填写即可 国内一般是省级单位，如广东、广西、中国香港；直辖市则填北京、上海 境外一般是国家名，如澳大利亚、新加坡 示例值：[上海] |
| ErrorTypes.N | 否 | Array of String | 错误类型 示例值：[正常] |
| City.N | 否 | Array of String | 城市 这里实际按拨测结果中的城市来填写即可 示例： 深圳市 武汉市 首尔 多伦多 示例值：[深圳市] |
| ScrollID | 否 | String | es scroll查询id 示例值：DXF1ZXJ5QW5kRmV0Y2gBAAAAAQEPczgWVU1RMC12VHhSUWlYa1I0dnU4aXlvUQ== |
| QueryFlag | 否 | String | 详情数据下载 示例值："download" |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DataSet | Array of DetailedSingleDataDefine | 单次详情数据 |
| TotalNumber | Integer | 符合条件的数据总数 示例值：10000 |
| ScrollID | String | es scroll查询的id 示例值：DXF1ZXJ5QW5kRmV0Y2gBAAAAAQEPczgWVU1RMC12VHhSUWlYa1I0dnU4aXlvUQ== |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 列出单次拨测详情数据
列出单次拨测详情数据
输入示例
POST / HTTP/1.1
Host: cat.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDetailedSingleProbeData
<公共请求参数>
{
"BeginTime": 1679899994107,
"EndTime": 1679903594107,
"TaskType": "AnalyzeTaskType_Network",
"SortField": "ProbeTime",
"Ascending": true,
"Offset": 0,
"Limit": 10,
"SelectedFields": [
"ProbeTime",
"City",
"Operator",
"ProbeIP"
],
"TaskID": [
"task-p4najqd4"
],
"ScrollID": "xxx"
}输出示例
{
"Response": {
"ScrollID": "xxx",
"TotalNumber": 10,
"DataSet": [
{
"ProbeTime": 1,
"Labels": [
{
"ID": 0,
"Name": "City",
"Value": "上海市"
}
],
"Fields": [
{
"ID": 0,
"Name": "ProbeTime",
"Value": 1679903537000
}
]
}
],
"RequestId": "asd"
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.DbQueryFailed | 数据库查询错误。 |
| FailedOperation.ESQueryError | ES查询错误。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound | 资源不存在。 |
| UnknownParameter | 未知参数错误。 |
