1. 接口描述
接口请求域名： live.tencentcloudapi.com 。
该接口为监控数据接口，数据采集及统计方式与计费数据不同，仅供运营分析使用，不能用于计费对账参考。
查询下行播放错误码信息。
默认接口请求频率限制：200次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribePlayErrorCodeSumInfoList。 |
| Version | 是 | String | 公共参数，本接口取值：2018-08-01。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| StartTime | 是 | String | 起始时间点，北京时间。 格式：yyyy-mm-dd HH:MM:SS。 示例值：2019-03-01 00:00:00 |
| EndTime | 是 | String | 结束时间点，北京时间。 格式：yyyy-mm-dd HH:MM:SS。 注：EndTime 和 StartTime 只支持最近1天的数据查询。 示例值：2019-03-01 12:00:00 |
| PlayDomains.N | 否 | Array of String | 播放域名列表，不填表示总体数据。 示例值：["5000.playdomain.com\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 |
| GroupType | 否 | String | 分组参数，可选值：CountryProIsp（默认值），Country（国家），默认是按照国家+省份+运营商来进行分组；目前国外的省份和运营商暂时无法识别。 示例值：CountryProIsp |
| OutLanguage | 否 | String | 输出字段使用的语言，可选值：Chinese（默认值），English，目前国家，省份和运营商支持多语言。 示例值：Chinese |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ProIspInfoList | Array of ProIspPlayCodeDataInfo | 分省份分运营商错误码为2或3或4或5开头的状态码数据信息。 |
| TotalCodeAll | Integer | 所有状态码的加和的次数。 示例值：100 |
| TotalCode4xx | Integer | 状态码为4开头的总次数。 示例值：10 |
| TotalCode5xx | Integer | 状态码为5开头的总次数。 示例值：29 |
| TotalCodeList | Array of PlayCodeTotalInfo | 各状态码的总次数。 |
| PageNum | Integer | 页号。 示例值：1 |
| PageSize | Integer | 每页大小。 示例值：10 |
| TotalPage | Integer | 总页数。 示例值：10 |
| TotalNum | Integer | 总记录数。 示例值：100 |
| TotalCode2xx | Integer | 状态码为2开头的总次数。 示例值：11 |
| TotalCode3xx | Integer | 状态码为3开头的总次数。 示例值：12 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
输入示例
https://live.tencentcloudapi.com/?Action=DescribePlayErrorCodeSumInfoList
&PlayDomains.0=5000.playdomain.com
&StartTime=2019-03-01 00:00:00
&EndTime=2019-03-01 12:00:00
&<公共请求参数>输出示例
{
"Response": {
"ProIspInfoList": [
{
"CountryAreaName": "中国",
"ProvinceName": "山东省",
"IspName": "中国移动",
"Code2xx": 11,
"Code3xx": 12,
"Code4xx": 10,
"Code5xx": 19
}
],
"TotalCodeList": [
{
"Code": "200",
"Num": 11
},
{
"Code": "302",
"Num": 12
},
{
"Code": "403",
"Num": 1000
},
{
"Code": "500",
"Num": 19
}
],
"TotalCodeAll": 100,
"TotalCode2xx": 11,
"TotalCode3xx": 12,
"TotalCode4xx": 10,
"TotalCode5xx": 29,
"PageNum": 1,
"PageSize": 10,
"TotalPage": 10,
"TotalNum": 100,
"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 | 用户主动停服。 |
