1. 接口描述
接口请求域名: cat.tencentcloudapi.com 。
查询拨测任务的返回码统计信息
默认接口请求频率限制:300次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:GetReturnCodeInfo。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-09。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
TaskId | 是 | Integer | 正整数。验证成功的拨测任务id |
BeginTime | 是 | String | 开始时间点。格式如:2017-05-09 10:20:00,最多拉群两天的数据 |
EndTime | 是 | String | 结束时间点。格式如:2017-05-09 10:25:00,最多拉群两天的数据 |
Province | 否 | String | 省份名称的全拼 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Details | Array of CatReturnDetail | 拨测失败详情列表 |
Summary | Array of CatReturnSummary | 拨测失败汇总列表 |
BeginTime | Timestamp | 开始时间 |
EndTime | Timestamp | 截至时间 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询拨测任务的返回码统计信息 示例
输入示例
https://cat.tencentcloudapi.com/?Action=GetReturnCodeInfo
&TaskId=260228
&BeginTime=2019-12-11 10:00:00
&EndTime=2019-12-11 20:30:00
&<公共请求参数>
输出示例
{
"Response": {
"Details": [
{
"IspName": "移动",
"Province": "beijing-1",
"ProvinceName": "北京(一区)",
"MapKey": "beijing-1",
"ServerIp": "119.29.5.164",
"ResultCount": 1568,
"ResultCode": 10016,
"ErrorReason": "Ping超时"
},
{
"IspName": "电信",
"Province": "beijing-1",
"ProvinceName": "北京(一区)",
"MapKey": "beijing-1",
"ServerIp": "119.29.5.164",
"ResultCount": 1609,
"ResultCode": 10016,
"ErrorReason": "Ping超时"
},
{
"IspName": "联通",
"Province": "beijing-1",
"ProvinceName": "北京(一区)",
"MapKey": "beijing-1",
"ServerIp": "119.29.5.164",
"ResultCount": 1581,
"ResultCode": 10016,
"ErrorReason": "Ping超时"
},
{
"IspName": "腾讯云",
"Province": "bangkok-1",
"ProvinceName": "曼谷(一区)",
"MapKey": "bangkok-1",
"ServerIp": "119.29.5.164",
"ResultCount": 3918,
"ResultCode": 10016,
"ErrorReason": "Ping超时"
}
],
"Summary": [
{
"ResultCode": 10016,
"ResultCount": 8676,
"ErrorReason": "Ping超时"
}
],
"BeginTime": "2019-12-11 10:00:00",
"EndTime": "2019-12-11 20:30:00",
"RequestId": "37bebabf-7868-46e7-a968-9054de07b978"
}
}
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
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
ResourceNotFound | 资源不存在。 |