All Products
Search
Document Center

ApsaraVideo Live:ListEdgeTranscodeJob

Last Updated:Dec 09, 2024

Queries edge transcoding tasks.

Operation description

  • You can call this operation to query edge transcoding tasks.
  • To call this operation, make sure that you have the permissions to access the edge transcoding feature.
  • You can query only tasks created or modified in the last 180 days.

QPS limit

You can call this operation up to 6,000 times per minute per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
live:ListEdgeTranscodeJob
*Domain
acs:live:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The ID of the data center.

cluster-1
TypestringNo

The type of edge transcoding. Valid values:

  • common: standard transcoding and Narrowband HD™ 1.0 transcoding.
  • nbhd-2: Narrowband HD™ 2.0 transcoding
  • ultra-hd: ultra-high definition transcoding
Note If you do not specify this parameter, the query results are filtered based on the types of edge transcoding on which you are granted permissions.
common
StatusintegerNo

The task status. Valid values:

  • 0: not started
  • 1: running
0
PageNointegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

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

20
SortBystringNo

The sort order of the tasks by creation time. Default value: desc. Valid values:

  • desc: descending order
  • asc: ascending order
desc
KeywordstringNo

The keyword of the query.

  • You can specify a task ID for an exact match.
  • You can specify a task name for a fuzzy match.
test

Notes about the request parameters

  • You can specify Type and Status to filter the query results by task type and status.
  • You can specify SortBy to sort the query results by creation time. By default, descending order is used.
  • You can set Keyword to a task ID for an exact match or a task name for a fuzzy match.

Response parameters

ParameterTypeDescriptionExample
object
JobListarray<object>

The edge transcoding tasks.

Jobobject
CreateTimestring

The time when the task was created.

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

The ID of the task.

****20b48fb04483915d4f2cd8ac****
LastStartAtstring

The time when the task was last started.

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

The time when the task was last stopped.

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

The name of the task.

my_job
Statusstring

The status of the task. Valid values:

  • 0: not started
  • 1: in progress
0
StreamInputstring

The URL of the input stream.

rtmp://mydomain/app/stream1
StreamOutputstring

The URL of the output stream.

rtmp://testdomain/app/stream2
TemplateIdstring

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

9b1571b513cb44f7a1ba6ae561ff****
TemplateNamestring

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

my_template
Typestring

The type of edge transcoding. Valid values:

  • common: standard transcoding and Narrowband HD™ 1.0 transcoding.
  • nbhd-2: Narrowband HD™ 2.0 transcoding
  • ultra-hd: ultra-high definition transcoding
common
RequestIdstring

The request ID.

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

The total number of entries returned.

100

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError message
400InvalidParameter%s
400MissingParameter%s
403OperationDenied%s

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history