1. 接口描述
接口请求域名: cat.tencentcloudapi.com 。
获取指定时刻的可用率地图信息
默认接口请求频率限制:300次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:GetAvailRatioHistory。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-09。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
TaskId | 是 | Integer | 拨测任务Id |
TimeStamp | 是 | Timestamp | 具体时间点 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
AvgAvailRatio | Float | 整体平均可用率 |
LowestAvailRatio | Float | 各省份最低可用率 |
LowestProvince | String | 可用率最低的省份 |
LowestIsp | String | 可用率最低的运营商 |
ProvinceData | Array of ProvinceDetail | 分省份的可用率数据 |
AvgTime | Float | 国内平均耗时,单位毫秒 |
AvgAvailRatio2 | Float | 国外平均可用率 |
AvgTime2 | Float | 国外平均耗时,单位毫秒 |
LowestAvailRatio2 | Float | 国外最低可用率 |
LowestProvince2 | String | 国外可用率最低的区域 |
LowestIsp2 | String | 国外可用率最低的运营商 |
ProvinceData2 | Array of ProvinceDetail | 国外分区域的可用率数据 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取指定时刻的可用率地图信息 示例
输入示例
https://cat.tencentcloudapi.com/?Action=GetAvailRatioHistory
&TaskId=260228
&TimeStamp=2019-12-10 11:27:00
&<公共请求参数>
输出示例
{
"Response": {
"AvgAvailRatio": 100,
"AvgTime": 37,
"LowestAvailRatio": 100,
"LowestProvince": "北京(一区)",
"LowestIsp": "腾讯云",
"ProvinceData": [
{
"AvgAvailRatio": 100,
"AvgTime": 37,
"ProvinceName": "北京(一区)",
"Mapkey": "beijing-1",
"TimeStamp": "2019-12-10 11:27:00",
"IspDetail": [
{
"IspName": "移动",
"AvailRatio": 100,
"AvgTime": 39
},
{
"IspName": "电信",
"AvailRatio": 100,
"AvgTime": 36
},
{
"IspName": "联通",
"AvailRatio": 100,
"AvgTime": 35
},
{
"IspName": "腾讯云",
"AvailRatio": 100,
"AvgTime": 38
}
],
"Province": "beijing-1"
}
],
"AvgAvailRatio2": 100,
"AvgTime2": 261,
"LowestAvailRatio2": 100,
"LowestProvince2": "莫斯科",
"LowestIsp2": "腾讯云",
"ProvinceData2": [
{
"AvgAvailRatio": 100,
"AvgTime": 261,
"ProvinceName": "莫斯科",
"Mapkey": "moscow",
"TimeStamp": "2019-12-10 11:27:00",
"IspDetail": [
{
"IspName": "腾讯云",
"AvailRatio": 100,
"AvgTime": 261
}
],
"Province": "moscow"
}
],
"RequestId": "d0791a07-6163-4e63-baad-97d244548d6f"
}
}
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 | 资源不存在。 |