1. 接口描述
接口请求域名: live.tencentcloudapi.com 。
该接口为监控数据接口,数据采集及统计方式与计费数据不同,仅供运营分析使用,不能用于计费对账参考。
查询某段时间内每个国家地区每个省份每个运营商的平均每秒流量,总流量,总请求数信息。
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeProIspPlaySumInfoList。 |
Version | 是 | String | 公共参数,本接口取值:2018-08-01。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
StartTime | 是 | String | 起始时间, 使用UTC格式时间, 例如:2019-01-08T10:00:00Z。 注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明。 示例值:2019-03-01 00:00:00 |
EndTime | 是 | String | 结束时间, 使用UTC格式时间, 例如:2019-01-08T10:00:00Z。 注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明。 注:EndTime 和 StartTime 只支持最近1天的数据查询。 示例值:2019-03-01 12:00:00 |
StatType | 是 | String | 统计的类型,可选值:”Province”(省份),”Isp”(运营商),“CountryOrArea”(国家或地区)。 示例值:Province |
PlayDomains.N | 否 | Array of String | 播放域名列表,不填则为全部。 示例值:["5000.playdomain.com\r\n"] |
PageNum | 否 | Integer | 页号,范围是[1,1000],默认值是1。 示例值:1 |
PageSize | 否 | Integer | 每页个数,范围是[1,1000],默认值是20。 示例值:100 |
MainlandOrOversea | 否 | String | 地域,可选值:Mainland,Oversea,China,Foreign,Global(默认值);如果为空,查询总的数据;如果为“Mainland”,查询中国大陆的数据;如果为“Oversea”,则查询中国大陆以外的数据;如果为China,查询中国的数据(包括港澳台);如果为Foreign,查询国外的数据(不包括港澳台)。 示例值:Mainland |
OutLanguage | 否 | String | 输出字段使用的语言,可选值:Chinese(默认值),English;目前国家,省份和运营商支持多语言。 示例值:Chinese |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalFlux | Float | 总流量。 示例值:100 |
TotalRequest | Integer | 总请求数。 示例值:100 |
StatType | String | 统计的类型。 示例值:Province |
PageSize | Integer | 每页的记录数。 示例值:10 |
PageNum | Integer | 页号。 示例值:1 |
TotalNum | Integer | 总记录数。 示例值:10 |
TotalPage | Integer | 总页数。 示例值:2 |
DataInfoList | Array of ProIspPlaySumInfo | 省份,运营商,国家或地区汇总数据列表。 |
AvgFluxPerSecond | Float | 下载速度,单位:MB/s,计算方式:总流量/总时长。 示例值:100 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
输入示例
POST / HTTP/1.1
Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProIspPlaySumInfoList
<公共请求参数>
{
"StatType": "Province",
"EndTime": "2019-03-01T12:00:00+08:00",
"StartTime": "2019-03-01T00:00:00+08:00",
"PlayDomains": [
"5000.playdomain.com"
]
}
输出示例
{
"Response": {
"DataInfoList": [
{
"Name": "山东省",
"TotalFlux": 50.0,
"TotalRequest": 50,
"AvgFluxPerSecond": 10.1
}
],
"TotalFlux": 100.0,
"TotalRequest": 100,
"AvgFluxPerSecond": 100,
"PageSize": 10,
"PageNum": 1,
"TotalNum": 10,
"TotalPage": 2,
"StatType": "Province",
"RequestId": "e6628973-db6a-48f1-9fcd-fe0b3ba54bc9"
}
}
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 | 操作失败。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
ResourceNotFound.ForbidService | 用户被禁用。 |
ResourceNotFound.FreezeService | 用户服务被冻结。 |
ResourceNotFound.StopService | 账号停服,请先冲正开通服务后再操作。 |
ResourceNotFound.UserDisableService | 用户主动停服。 |