1. 接口描述
接口请求域名: live.tencentcloudapi.com 。
该接口为监控数据接口,数据采集及统计方式与计费数据不同,仅供运营分析使用,不能用于计费对账参考。
查询按省份和运营商分组的下行播放数据。
默认接口请求频率限制:200次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeGroupProIspPlayInfoList。 |
Version | 是 | String | 公共参数,本接口取值:2018-08-01。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
StartTime | 是 | String | 起始时间点, 使用UTC格式时间, 例如:2019-01-08T10:00:00Z。 注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明。 示例值:2019-03-29 09:00:00 |
EndTime | 是 | String | 结束时间点, 使用UTC格式时间, 例如:2019-01-08T10:00:00Z。 注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明。 时间跨度在(0,3小时],支持最近1个月数据查询。 示例值:2019-03-29 09:10:00 |
PlayDomains.N | 否 | Array of String | 播放域名,默认为不填,表示求总体数据。 示例值:["live.com"] |
ProvinceNames.N | 否 | Array of String | 省份列表,默认不填,则返回各省份的数据。 示例值:["Beijing"] |
IspNames.N | 否 | Array of String | 运营商列表,默认不填,则返回整个运营商的数据。 示例值:["China Mobile"] |
MainlandOrOversea | 否 | String | 国内还是国外,如果为空,查询所有地区数据;如果为“Mainland”,查询国内数据;如果为“Oversea”,则查询国外数据。 示例值:Mainland |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DataInfoList | Array of GroupProIspDataInfo | 数据内容。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
省份和运营商参考: 映射表
输入示例
POST / HTTP/1.1
Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGroupProIspPlayInfoList
<公共请求参数>
{
"EndTime": "2019-03-29T09:10:00+08:00",
"StartTime": "2019-03-29T09:00:00+08:00"
}
输出示例
{
"Response": {
"DataInfoList": [
{
"DetailInfoList": [
{
"Bandwidth": 863.073,
"Flux": 6473.05,
"Online": 540,
"Request": 449,
"Time": "2019-03-29T09:00:00+08:00"
},
{
"Bandwidth": 891.49,
"Flux": 6686.173,
"Online": 524,
"Request": 455,
"Time": "2019-03-29T09:05:00+08:00"
},
{
"Bandwidth": 847.715,
"Flux": 6357.859,
"Online": 612,
"Request": 578,
"Time": "2019-03-29T09:10:00+08:00"
}
],
"IspName": "电信",
"ProvinceName": "广东省"
},
{
"DetailInfoList": [
{
"Bandwidth": 213.405,
"Flux": 1600.537,
"Online": 132,
"Request": 184,
"Time": "2019-03-29T09:00:00+08:00"
},
{
"Bandwidth": 215.738,
"Flux": 1618.032,
"Online": 125,
"Request": 122,
"Time": "2019-03-29T09:05:00+08:00"
},
{
"Bandwidth": 226.96,
"Flux": 1702.203,
"Online": 131,
"Request": 131,
"Time": "2019-03-29T09:10:00+08:00"
}
],
"IspName": "联通",
"ProvinceName": "广东省"
}
],
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}
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 | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
ResourceNotFound.ForbidService | 用户被禁用。 |
ResourceNotFound.FreezeService | 用户服务被冻结。 |
ResourceNotFound.StopService | 账号停服,请先冲正开通服务后再操作。 |
ResourceNotFound.UserDisableService | 用户主动停服。 |
UnsupportedOperation | 操作不支持。 |