全部产品
Search

搜索本产品

    视频直播：DescribeLivePullToPushList - 模糊查询拉转推任务

    文档中心

    视频直播：DescribeLivePullToPushList - 模糊查询拉转推任务

    更新时间：Apr 09, 2025

    模糊查询拉流转推任务

    接口说明

    • 调用本接口查询拉流转推任务列表。
    • 支持分页查询任务列表，支持以任务 ID、任务名称和目标推流地址进行模糊搜索。

    QPS 限制

    本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用前面加 * 表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    live:DescribeLivePullToPushListget
    *全部资源
    *
      无
    		无

    请求参数

    名称类型必填描述示例值
    Regionstring是

    指定直播中心查询。取值：

    • ap-southeast-1（新加坡）
    • ap-southeast-5（印度尼西亚）
    • cn-beijing（北京）
    • cn-shanghai（上海）
    枚举值：
    • ap-northeast-1
    • ap-southeast-1
    • ap-southeast-5
    • eu-central-1
    • me-central-1
    • cn-beijing
    • cn-shanghai
    • cn-shenzhen
    • cn-qingdao
    • preregion
    		cn-shanghai
    TaskIdstring否

    任务 ID，根据任务 ID 模糊搜索。

    说明 任务 ID 由大小写字母、数字、下划线、短划线（-）组成，最大 55 字符。
    		861009
    TaskNamestring否

    任务名称，根据任务名称模糊搜索。

    		task
    DstUrlstring否

    目标推流地址，根据目标推流地址模糊搜索。

    		rtmp://qd
    PageNumberinteger否

    页码。

    说明 该参数取值大于 0 且不超过 Integer 数据类型的最大值，默认值为 1。
    		1
    PageSizeinteger否

    每页可展示的记录数。

    说明 默认值为 10，取值范围[1,100]。
    		10

    返回参数

    名称类型描述示例值
    object

    Schema of Response

    RequestIdstring

    请求 id。

    		a05e6b15-15af-405b-a4a2-0152245*****
    Totalinteger

    查询结果总数。

    		3
    PageNumberinteger

    分页页数。

    		1
    PageSizeinteger

    每页的查询记录数。

    		10
    TaskListarray<object>

    任务信息列表。

    TaskListobject

    任务信息列表

    TaskIdstring

    任务 ID。

    		fb0d4ac7-c7e3-4978-9743-0bf2f6e8****
    TaskStatusinteger

    任务当前状态：

    • 0：未启动（未到开始时间）。
    • 1：正常运行（拉流和转推正常）。
    • 2：异常运行。
    • 3：已停止（拉流或转推异常，也有可能是主动调用接口停止）.
    • -1：已退出。
    		0
    TaskInvalidReasonstring

    任务停止运行原因：

    • PullStreamFailed：源流拉流异常，重试中。
    • PushStreamFailed：目标流推流异常，重试中。
    • UnknownError：未知异常。
    说明 仅停止运行状态下返回。
    		PullStreamFailed
    TaskExitTimeinteger

    任务退出时间，Unix 秒级时间戳。

    说明 仅已退出状态下返回。
    		1726354625
    TaskExitReasonstring

    任务退出原因：

    • TriggerByUser：用户主动结束。
    • OverEndTime：超过预设结束时间。
    说明 仅已退出状态下返回。
    		TriggerByUser
    CurrentOffsetinteger

    当前生效的视频播放偏移。

    		0
    CurrentFileIndexinteger

    当前生效的节目单序列偏移。

    		0
    TaskInfoobject

    任务信息。

    TaskIdstring

    任务 ID。

    		fb0d4ac7-c7e3-4978-9743-0bf2f6e8****
    TaskNamestring

    任务名称。

    		taskname
    StartTimestring

    任务开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

    		2024-12-04T09:16:00Z
    EndTimestring

    任务结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

    		2024-12-30T14:30:00Z
    SourceTypestring

    源流类型，枚举值：

    • live，直播流。
    • vod，阿里云视频点播资源。
    • url，第三方视频文件资源。
    		vod
    SourceProtocolstring

    源流协议名。

    		flv
    SourceUrlsarray

    源流 URL 地址。

    sourceUrlsstring

    源流 URL 地址。

    		rtmp://118.178.***.*5:****/wwtestlive1/pulltest.jiugong.aliyunlive.com_livelight2?vhost=pulltest.jiugong.aliyun*******
    DstUrlstring

    推流目标地址。

    		rtmp://qd.push.lgg.alivecdn.com/testhsc/streamhsc?live_rtmp_*******
    CallbackURLstring

    HTTP 回调地址。

    		hahaha.com
    Offsetinteger

    启动偏移，视频文件起始偏移值。单位：秒。取值：大于 0。

    说明
  • 表示从相对于首帧的偏差时间作为开始读取的位置。
  • 仅对点播资源或视频文件有效。
    •
    		0
    FileIndexinteger

    文件索引，从第 n 个文件开始播放起。

    		0
    RetryCountinteger

    重试次数。

    		3
    RetryIntervalinteger

    重试间隔，单位秒。

    		60
    RepeatNumberinteger

    播放完后重复继续播放的次数。取值：

    • 0（默认值）：不重复播放。
    • -1：一直循环重复。
    • 其他正整数：播放完后重复继续播放的次数。
    说明 此参数仅针对点播或第三方视频流。
    		0

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "a05e6b15-15af-405b-a4a2-0152245*****",
  "Total": 3,
  "PageNumber": 1,
  "PageSize": 10,
  "TaskList": [
    {
      "TaskId": "fb0d4ac7-c7e3-4978-9743-0bf2f6e8****",
      "TaskStatus": 0,
      "TaskInvalidReason": "PullStreamFailed",
      "TaskExitTime": 1726354625,
      "TaskExitReason": "TriggerByUser",
      "CurrentOffset": 0,
      "CurrentFileIndex": 0,
      "TaskInfo": {
        "TaskId": "fb0d4ac7-c7e3-4978-9743-0bf2f6e8****",
        "TaskName": "taskname",
        "StartTime": "2024-12-04T09:16:00Z",
        "EndTime": "2024-12-30T14:30:00Z",
        "SourceType": "vod",
        "SourceProtocol": "flv",
        "SourceUrls": [
          "rtmp://118.178.***.*5:****/wwtestlive1/pulltest.jiugong.aliyunlive.com_livelight2?vhost=pulltest.jiugong.aliyun*******"
        ],
        "DstUrl": "rtmp://qd.push.lgg.alivecdn.com/testhsc/streamhsc?live_rtmp_*******",
        "CallbackURL": "hahaha.com",
        "Offset": 0,
        "FileIndex": 0,
        "RetryCount": 3,
        "RetryInterval": 60,
        "RepeatNumber": 0
      }
    }
  ]
}

    错误码

    HTTP status code错误码错误信息描述
    400InvalidParameter%s.参数错误
    400LiveServiceNotFoundYour account does not open Live service yet您的账户尚未开通直播服务
    500InternalError%s.直播 liveapi 服务端错误。

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2025-04-01OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情