All Products
Search

This Product

    ApsaraVideo Live:DescribeLivePullToPushList

    Document Center

    ApsaraVideo Live:DescribeLivePullToPushList

    Last Updated:Jun 22, 2026

    Fuzzy query for stream pulling and pushing tasks.

    Operation description

    • Call this API to query the list of stream pulling and pushing tasks.

    • Supports paginated query of the task list, and supports fuzzy search by task ID, task name, and destination push stream URL.

    QPS Limit

    The single-user QPS limit for this API is 10 calls per second. Exceeding the limit will result in API throttling, which may affect your business. Please call this API appropriately.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    live:DescribeLivePullToPushList

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    No

    Region ID.

    cn-shanghai
    Region

    string

    Yes

    Specifies the live center for query. Valid values:

    • ap-southeast-1 (Singapore)

    • ap-southeast-5 (Indonesia)

    • cn-beijing (Beijing)

    • cn-shanghai (Shanghai)

    Valid values:

    • cn-shenzhen :

      Shenzhen

    • cn-qingdao :

      Qingdao

    • preregion :

      Pre-release

    • cn-beijing :

      Beijing

    • cn-shanghai :

      Shanghai

    • ap-southeast-1 :

      Singapore

    • eu-central-1 :

      Germany-Frankfurt

    • ap-northeast-1 :

      Japan-Tokyo

    • ap-southeast-5 :

      Indonesia

    • me-central-1 :

      Saudi Arabia-Riyadh

    cn-shanghai
    TaskId

    string

    No

    Task ID. Fuzzy search based on task ID.

    Note

    The task ID consists of uppercase and lowercase letters, digits, underscores, and hyphens (-), with a maximum of 55 characters.

    861009
    TaskName

    string

    No

    Task name. Fuzzy search based on task name.

    task
    DstUrl

    string

    No

    Destination push stream URL. Fuzzy search based on destination push stream URL.

    rtmp://qd
    PageNumber

    integer

    No

    Page number.

    Note

    The value of this parameter must be greater than 0 and cannot exceed the maximum value of Integer data type. Default value: 1.

    1
    PageSize

    integer

    No

    Number of records displayed per page.

    Note

    Default value: 10. Value range: [1, 100].

    10

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    Request ID.

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

    integer

    Total number of query results.

    3
    PageNumber

    integer

    Page number.

    1
    PageSize

    integer

    Number of query records per page.

    10
    TaskList

    array<object>

    Task information list.

    array<object>

    Task information list.

    TaskId

    string

    Task ID.

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

    integer

    Current task status:

    • 0: Not started (start time has not been reached).

    • 1: Running normally (stream pulling and pushing are normal).

    • 2: Running abnormally.

    • 3: Stopped (stream pulling or pushing is abnormal, or the task was actively stopped by calling the API).

    • -1: Exited.

    0
    TaskInvalidReason

    string

    Reason for task stopping:

    • PullStreamFailed: Source stream pulling exception, retrying.

    • PushStreamFailed: Destination stream pushing exception, retrying.

    • UnknownError: Unknown exception.

    Note

    Only returned when the task is in stopped state.

    PullStreamFailed
    TaskExitTime

    integer

    Task exit time, Unix timestamp in seconds.

    Note

    Only returned when the task is in exited state.

    1726354625
    TaskExitReason

    string

    Task exit reason:

    • TriggerByUser: Actively ended by user.

    • OverEndTime: Exceeded the preset end time.

    Note

    Only returned when the task is in exited state.

    TriggerByUser
    CurrentOffset

    integer

    Currently effective video playback offset.

    0
    CurrentFileIndex

    integer

    Currently effective playlist sequence offset.

    0
    TaskInfo

    object

    Task information.

    TaskId

    string

    The task ID.

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

    string

    The task name.

    taskname
    StartTime

    string

    The start time of the task. The time is in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

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

    string

    The end time of the task. The time is in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

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

    string

    The type of the source stream. Valid values:

    • live: a live stream.

    • vod: an ApsaraVideo VOD resource.

    • url: a third-party video file resource.

    vod
    SourceProtocol

    string

    The protocol of the source stream.

    flv
    SourceUrls

    array

    The source stream URLs.

    string

    The source stream URL.

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

    string

    The destination ingest URL.

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

    string

    The HTTP webhook address.

    hahaha.com
    Offset

    integer

    The start offset of the video file in seconds. The value must be greater than 0.

    Note

    • This indicates the time offset relative to the first frame from which to start reading.

    • This parameter is valid only for ApsaraVideo VOD resources or video files.

    0
    FileIndex

    integer

    The index of the file from which to start playback.

    0
    RetryCount

    integer

    The number of retries.

    3
    RetryInterval

    integer

    The retry interval in seconds.

    60
    RepeatNumber

    integer

    The number of times to repeat the playback after it is complete. Valid values:

    • 0 (default): The playback is not repeated.

    • -1: The playback is repeated in a loop.

    • A positive integer: The number of times to repeat the playback.

    Note

    This parameter is valid only for ApsaraVideo VOD or third-party video streams.

    0

    Examples

    Success response

    JSON format

    {
  "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
      }
    }
  ]
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParameter %s. Parameter error
    400 LiveServiceNotFound Your account does not open Live service yet Your account has not yet activated ApsaraVideo Live.
    400 CodeInvalidAliUid This aliuid does not have a live domain name. This aluid does not have a live domain name.
    400 CodeTaskNotExist Task does not exist. The task does not exist.
    500 InternalError %s. error on the live liveapi server.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.