1. 接口描述
接口请求域名: live.tencentcloudapi.com 。
该接口为监控数据接口,数据采集及统计方式与计费数据不同,仅供运营分析使用,不能用于计费对账参考。
支持查询某天或某段时间的转码详细信息。由于转码数据量较大,如果查询时间跨度太长可能会拉不到数据,可以尝试将查询时间范围缩小些再重试。
默认接口请求频率限制:200次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeLiveTranscodeDetailInfo。 |
Version | 是 | String | 公共参数,本接口取值:2018-08-01。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
PushDomain | 否 | String | 推流域名。 示例值:test.push.com |
StreamName | 否 | String | 流名称。 示例值:streamtest |
DayTime | 否 | String | 查询时间,北京时间, 格式:yyyymmdd。 注意:支持查询近1个月内某天的详细数据,截止到昨天。 示例值:20190307 |
PageNum | 否 | Integer | 页数,默认1, 不超过100页。 示例值:1 |
PageSize | 否 | Integer | 每页个数,默认20, 范围:[10,1000]。 示例值:20 |
StartDayTime | 否 | String | 起始天时间,北京时间, 格式:yyyymmdd。 注意:支持查询近1个月内的详细数据。 示例值:20190307 |
EndDayTime | 否 | String | 结束天时间,北京时间, 格式:yyyymmdd。 注意:支持查询近1个月内的详细数据,截止到昨天,注意DayTime 与(StartDayTime,EndDayTime)必须要传一个,如果都传,会以DayTime为准 。 示例值:20190307 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DataInfoList | Array of TranscodeDetailInfo | 统计数据列表。 |
PageNum | Integer | 页码。 示例值:1 |
PageSize | Integer | 每页个数。 示例值:20 |
TotalNum | Integer | 总个数。 示例值:1 |
TotalPage | Integer | 总页数。 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
输入示例
POST / HTTP/1.1
Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLiveTranscodeDetailInfo
<公共请求参数>
{
"PageNum": "1",
"PageSize": "20",
"DayTime": "20190307"
}
输出示例
{
"Response": {
"DataInfoList": [
{
"StreamName": "test",
"StartTime": "2019-03-01 01:00",
"EndTime": "2019-03-01 04:00",
"Duration": 8,
"ModuleCodec": "liveprocessor_H264",
"Bitrate": 120,
"Type": "混流",
"PushDomain": "5000.livepush.com",
"Resolution": "480P",
"MainlandOrOversea": "Mainland"
}
],
"PageNum": 1,
"PageSize": 20,
"TotalNum": 1,
"TotalPage": 1,
"RequestId": "8e50cdb5-56dc-408b-89b0-31818958d424"
}
}
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 | 操作失败。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
ResourceNotFound.ForbidService | 用户被禁用。 |
ResourceNotFound.FreezeService | 用户服务被冻结。 |
ResourceNotFound.StopService | 账号停服,请先冲正开通服务后再操作。 |
ResourceNotFound.UserDisableService | 用户主动停服。 |