查询直播拉流任务

最近更新时间:2024-07-12 01:19:48

我的收藏

1. 接口描述

接口请求域名: live.tencentcloudapi.com 。

查询使用 CreateLivePullStreamTask 接口创建的直播拉流任务。
排序方式:默认按更新时间 倒序排列。

默认接口请求频率限制:30次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeLivePullStreamTasks。
Version String 公共参数,本接口取值:2018-08-01。
Region String 公共参数,详见产品支持的 地域列表
TaskId String 任务 ID。
来源:调用 CreateLivePullStreamTask 接口时返回。
不填默认查询所有任务,按更新时间倒序排序。
示例值:123
PageNum Integer 取得第几页,默认值:1。
示例值:1
PageSize Integer 分页大小,默认值:10。
取值范围:1~20 之前的任意整数。
示例值:10

3. 输出参数

参数名称 类型 描述
TaskInfos Array of PullStreamTaskInfo 直播拉流任务信息列表。
PageNum Integer 分页的页码。
示例值:1
PageSize Integer 每页大小。
示例值:10
TotalNum Integer 符合条件的总个数。
示例值:1
TotalPage Integer 总页数。
示例值:1
LimitTaskNum Integer 限制可创建的最大任务数。
示例值:20
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

查询直播拉流任务。

输入示例

POST / HTTP/1.1
Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLivePullStreamTasks
<公共请求参数>

{
    "TaskId": "123"
}

输出示例

{
    "Response": {
        "TaskInfos": [
            {
                "AppName": "live",
                "Region": "ap-beijing",
                "CallbackInfo": "",
                "CallbackEvents": [
                    "TaskStart",
                    "TaskExit"
                ],
                "CallbackUrl": "",
                "CreateBy": "yourname",
                "DomainName": "yourdomain.com",
                "EndTime": "2020-04-25T00:30:00Z",
                "ErrorInfo": "",
                "BackupToUrl": "",
                "RecordTemplateId": "",
                "PushArgs": "txsecret=7cbb8f382a21e8d2f6cd8098100d3b8e&txtime=5ea0450d",
                "SourceType": "PullLivePushLive",
                "SourceUrls": [
                    "http://yourdomain/live/test.flv"
                ],
                "StartTime": "2020-04-20T00:30:00Z",
                "Status": "enable",
                "StreamName": "teststream",
                "Comment": "abc",
                "TaskId": "10054",
                "UpdateBy": "",
                "UpdateTime": "2020-04-23T05:07:43Z",
                "CreateTime": "2020-04-20T05:07:43Z",
                "VodLoopTimes": -1,
                "VodRefreshType": "ImmediateNewSource",
                "VodLocalMode": 0,
                "BackupSourceType": "",
                "BackupSourceUrl": "",
                "WatermarkList": [],
                "RecentPullInfo": {
                    "FileUrl": "http://yourdomain/live/test.flv",
                    "OffsetTime": 95,
                    "LoopedTimes": 0,
                    "ReportTime": "2020-04-23T08:20:39Z"
                }
            }
        ],
        "PageNum": 1,
        "PageSize": 10,
        "TotalNum": 1,
        "TotalPage": 1,
        "LimitTaskNum": 20,
        "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。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
FailedOperation.CallOtherSvrFailed 调用内部服务失败。
InternalError 内部错误。
ResourceNotFound.ForbidService 用户被禁用。
ResourceNotFound.FreezeService 用户服务被冻结。
ResourceNotFound.StopService 账号停服,请先冲正开通服务后再操作。
ResourceNotFound.UserDisableService 用户主动停服。
ResourceNotFound.UserNotExist 用户未注册直播。