All Products
Search

This Product

    ApsaraVideo Live:DescribeLiveStreamPreloadTasks

    Document Center

    ApsaraVideo Live:DescribeLiveStreamPreloadTasks

    Last Updated:Dec 24, 2025

    Retrieves prefetch tasks in the last three days.

    Operation description

    QPS limit

    You can call this operation up to 10 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions.

    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:DescribeLiveStreamPreloadTasks

    *Domain

    acs:cdn:*:{#accountId}:domain/{#DomainName}

    None

    None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    RegionId

    string

    No

    The region ID.

    cn-shanghai

    DomainName

    string

    Yes

    The streaming domain.

    example.com

    TaskId

    string

    No

    The task ID. Call the SetLiveStreamPreloadTasks operation to obtain the ID of a prefetch task.

    yourTaskId

    PlayUrl

    string

    No

    A comma-separated list of the live stream URLs to prefetch. You can specify up to 100 URLs.

    rtmp://guide.aliyundoc.com/liveApp****/liveStream****

    PageSize

    integer

    No

    The number of entries per page. Valid values: 1 to 100.

    10

    PageNum

    integer

    No

    The page number. Default value: 1.

    1

    Status

    string

    No

    The status of the prefetch task. Valid values:

    • complete

    • pending

    • preloading

    • failed

    complete

    StartTime

    string

    No

    The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. You can query only data in the previous three days.

    2016-06-29T19:00:00Z

    EndTime

    string

    No

    The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The interval between the start time and end time cannot exceed three days.

    2016-06-30T19:00:00Z

    Response elements

    Element

    Type

    Description

    Example

    object

    PageNum

    integer

    The page number.

    1

    PageSize

    integer

    The number of entries per page.

    2

    PreloadTasks

    object

    PreloadTask

    array<object>

    The details of the prefetch task.

    object

    The details of the prefetch task.

    Area

    string

    The acceleration region where you want to prefetch the live content. Valid values:

    • domestic: regions in the Chinese mainland.

    • overseas: regions outside the Chinese mainland.

    • global: regions in and outside the Chinese mainland.

    Note

    If you do not specify this parameter, the acceleration region of the domain name is returned.

    domestic

    CreateTime

    string

    The time when the prefetch task was created.

    2016-06-29T19:00:00Z

    Description

    string

    Indicates whether the prefetch task was successful. Valid values:

    • Successfully

    • InternalError

    Successfully

    DomainName

    string

    The streaming domain.

    example.com

    PlayUrl

    string

    The live stream URL.

    rtmp://guide.aliyundoc.com/liveApp****/liveStream****

    PreloadedEndTime

    string

    The time when the prefetch task ended.

    2016-06-30T19:00:00Z

    PreloadedStartTime

    string

    The time when the prefetch task started.

    2016-06-29T19:00:00Z

    Process

    string

    The progress of the prefetch task.

    100%

    Status

    string

    The status of the prefetch task. Valid values:

    • Success

    • Failed

    Note

    Success is returned only if the prefetch task is configured for all specified URLs.

    Success

    TaskId

    string

    The task ID.

    yourTaskId

    RequestId

    string

    The request ID.

    E1564CBC-DCFE-5E1B-8B78-8DED9A39F334

    TotalNum

    integer

    The total number of entries returned.

    1

    TotalPage

    integer

    The total number of pages.

    1

    Examples

    Success response

    JSON format

    {
  "PageNum": 1,
  "PageSize": 2,
  "PreloadTasks": {
    "PreloadTask": [
      {
        "Area": "domestic",
        "CreateTime": "2016-06-29T19:00:00Z",
        "Description": "Successfully",
        "DomainName": "example.com",
        "PlayUrl": "rtmp://guide.aliyundoc.com/liveApp****/liveStream****",
        "PreloadedEndTime": "2016-06-30T19:00:00Z",
        "PreloadedStartTime": "2016-06-29T19:00:00Z",
        "Process": "100%",
        "Status": "Success",
        "TaskId": "yourTaskId"
      }
    ]
  },
  "RequestId": "E1564CBC-DCFE-5E1B-8B78-8DED9A39F334",
  "TotalNum": 1,
  "TotalPage": 1
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description

    400

    InvalidParam

    Parameter invalid.

    Illegal input parameters

    400

    InvalidEndTime.Mismatch

    Specified end time does not match the specified start time.

    400

    Duration.Exceed

    Duration between StartTime and EndTime is too long.

    500

    InternalError

    The request processing has failed due to backend service exception.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.