1. 接口描述
接口请求域名: live.tencentcloudapi.com 。
查询指定时间段范围内启动和结束的录制任务列表。
- 使用前提
- 仅用于查询由 CreateRecordTask 接口创建的录制任务。
- 不能查询被 DeleteRecordTask 接口删除以及已过期(平台侧保留3个月)的录制任务。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeRecordTask。 |
Version | 是 | String | 公共参数,本接口取值:2018-08-01。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou 。 |
StartTime | 是 | Integer | 查询任务开始时间,Unix 时间戳。设置时间不早于当前时间之前90天的时间,且查询时间跨度不超过一周。 示例值:1595779200 |
EndTime | 是 | Integer | 查询任务结束时间,Unix 时间戳。EndTime 必须大于 StartTime,设置时间不早于当前时间之前90天的时间,且查询时间跨度不超过一周。(注意:任务开始结束时间必须在查询时间范围内)。 示例值:1595865600 |
StreamName | 否 | String | 流名称。 示例值:livetest |
DomainName | 否 | String | 推流域名。 示例值:5000.live.push.com |
AppName | 否 | String | 推流路径。 示例值:live |
ScrollToken | 否 | String | 翻页标识,分批拉取时使用:当单次请求无法拉取所有数据,接口将会返回 ScrollToken,下一次请求携带该 Token,将会从下一条记录开始获取。 示例值:RF1bV9tRVVEW= |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ScrollToken | String | 翻页标识,当请求未返回所有数据,该字段表示下一条记录的 Token。当该字段为空,说明已无更多数据。 示例值:RF1bV9tRVVEW= |
TaskList | Array of RecordTask | 录制任务列表。当该字段为空,说明已返回所有数据。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
输入示例
https://live.tencentcloudapi.com/?Action=DescribeRecordTask
&AppName=live
&DomainName=5000.live.push.com
&StreamName=livetest
&StartTime=1595779200
&EndTime=1595865600
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "eac6b301-a322-493a-8e36-83b295459397",
"ScrollToken": "",
"TaskList": [
{
"TaskId": "UpTbk5RSVhRQFkAAfHwQCCjcRD0lRFcZ0xTSlNTQltlRVRLU1JAWW9EUb",
"DomainName": "5000.live.push.com",
"AppName": "live",
"StreamName": "livetest",
"StartTime": 1595779900,
"EndTime": 1595789900,
"TemplateId": 123,
"Stopped": 1595783500
},
{
"TaskId": "UpTbk5RSVhRQFkAAfHwQCCjcRD0lRFcZ0xTSlNTQltlRVRLFszdDWW9EUb",
"DomainName": "5000.live.push.com",
"AppName": "live",
"StreamName": "livetest",
"StartTime": 1595789900,
"EndTime": 1595799900,
"TemplateId": 0,
"Stopped": 0
}
]
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InternalError.GetConfigError | 获取配置错误。 |
InternalError.NetworkError | 内部网络错误。 |
InvalidParameter | 参数错误。 |
ResourceNotFound.ForbidService | 用户被禁用。 |
ResourceNotFound.FreezeService | 用户服务被冻结。 |
ResourceNotFound.StopService | 账号停服,请先冲正开通服务后再操作。 |
ResourceNotFound.UserDisableService | 用户主动停服。 |
UnsupportedOperation | 操作不支持。 |