All Products
Search

This Product

    ApsaraVideo Live:ListEdgeTranscodeJob

    Document Center

    ApsaraVideo Live:ListEdgeTranscodeJob

    Last Updated:Sep 14, 2026

    Queries the list of edge transcoding tasks.

    Operation description

    • This operation queries the list of edge transcoding tasks.

    • You must have the permissions to access the edge transcoding service before you can call this operation.

    • This operation returns only tasks from the last 180 days, and the last operation time must be within this 180-day period.

    QPS limit

    The QPS limit for a single user of this operation is 6,000 calls per minute. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation as needed.

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

    list

    *Domain

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    No

    The region ID.

    cn-shanghai
    ClusterId

    string

    Yes

    The data center ID. The specific value must be determined by submitting a ticket or consulting with your account manager per the agreed convention. To submit a ticket, see Contact us.

    cluster-1
    Type

    string

    No

    The edge transcoding type. Valid values:

    • common: default transcoding (standard + Narrowband HD 1.0).

    • nbhd-2: Narrowband HD 2.0.

    • ultra-hd: ultra-high definition.

    Note

    If this parameter is not specified, transcoding templates for which the user has the corresponding transcoding type permissions are displayed.

    common
    Status

    integer

    No

    The edge transcoding task status. Valid values:

    • 0: not started.

    • 1: running.

    0
    PageNo

    integer

    No

    The page number. Default value: 1.

    1
    PageSize

    integer

    No

    The number of entries per page. Default value: 10. Maximum value: 100.

    20
    SortBy

    string

    No

    The sorting rule. Results are sorted by CreateTime. Default value: desc. Valid values:

    • desc: descending order.

    • asc: ascending order.

    desc
    Keyword

    string

    No

    The search keyword. Valid values:

    • Task ID. Exact match is supported for task IDs.

    • Task name. Fuzzy match is supported for task names.

    test

    Request parameter description

    • This operation supports filtered query results by transcoding type (Type) and transcoding task status (Status).

    • This operation supports sorting query results by task creation time (CreateTime). The default sorting order is descending.

    • This operation supports querying by keyword (Keyword) using task ID (exact match) or task name (fuzzy match).

    Response elements

    Element

    Type

    Description

    Example

    object

    JobList

    object

    Job

    array<object>

    The list of edge transcoding tasks.

    object

    CreateTime

    string

    The time when the task was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).

    2023-07-24T16:44:55Z
    JobId

    string

    The task ID.

    ****20b48fb04483915d4f2cd8ac****
    LastStartAt

    string

    The time when the task was last started. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).

    2023-07-25T02:48:58Z
    LastStopAt

    string

    The time when the task was last stopped. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).

    2023-07-25T05:48:58Z
    Name

    string

    The task name.

    my_job
    Status

    string

    The edge transcoding task status. Valid values:

    • 0: not started.

    • 1: running.

    0
    StreamInput

    string

    The input stream URL.

    rtmp://mydomain/app/stream1
    StreamOutput

    string

    The output stream URL.

    rtmp://testdomain/app/stream2
    TemplateId

    string

    The ID of the edge transcoding template used by the task.

    9b1571b513cb44f7a1ba6ae561ff****
    TemplateName

    string

    The name of the edge transcoding template used by the task.

    my_template
    Type

    string

    The edge transcoding type. Valid values:

    • common: default transcoding (standard + Narrowband HD 1.0).

    • nbhd-2: Narrowband HD 2.0.

    • ultra-hd: ultra-high definition.

    common
    RequestId

    string

    The request ID.

    ******3B-0E1A-586A-AC29-742247******
    TotalCount

    integer

    The total number of entries.

    100

    Examples

    Success response

    JSON format

    {
  "JobList": {
    "Job": [
      {
        "CreateTime": "2023-07-24T16:44:55Z",
        "JobId": "****20b48fb04483915d4f2cd8ac****",
        "LastStartAt": "2023-07-25T02:48:58Z",
        "LastStopAt": "2023-07-25T05:48:58Z",
        "Name": "my_job",
        "Status": "0",
        "StreamInput": "rtmp://mydomain/app/stream1",
        "StreamOutput": "rtmp://testdomain/app/stream2",
        "TemplateId": "9b1571b513cb44f7a1ba6ae561ff****",
        "TemplateName": "my_template",
        "Type": "common"
      }
    ]
  },
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "TotalCount": 100
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParameter %s. Parameter error
    400 MissingParameter %s. Missing parameter
    403 OperationDenied %s, please check and try again later. Operation rejected, please check and try again.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.