GetEdgeTranscodeJob - - Alibaba Cloud Documentation Center

Queries the details of an edge transcoding job.

Operation description

To call this API operation, you must have permissions for the edge transcoding service.

QPS limits

The queries per second (QPS) limit for a single user on this API is 6,000 calls per minute. API calls that exceed this limit are throttled. This may affect your business. We recommend that you call the API at a reasonable rate.

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

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
ClusterId	string	Yes	The data center ID.	****3b-4d18-395c-8106-ff21a6****
JobId	string	Yes	The ID of the edge transcoding job.	**20b48fb04483915d4f2cd8ac**

Response elements

Element	Type	Description	Example
	object
Job	object	The edge transcoding job.
CreateTime	string	The time when the job was created.	2023-07-24T16:44:55Z
JobId	string	The job ID.	**20b48fb04483915d4f2cd8ac**
LastStartAt	string	The time when the job was last started.	2023-07-25T02:48:58Z
LastStopAt	string	The time when the job was last stopped.	2023-07-25T05:48:58Z
Name	string	The job name.	my_job
Status	string	The status of the transcoding job. Valid values: 0: The job is not started. 1: The job is 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 job.	9b1571b513cb44f7a1ba6ae561ff****
TemplateName	string	The name of the edge transcoding template used by the job.	my_template
Type	string	The type of edge transcoding. Valid values: common: standard transcoding and 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****

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	%s.	Missing parameter
403	OperationDenied	%s, please check and try again later.	Operation rejected, please check and try again.
404	JobNotFound	%s, please check and try again later.	Task does not exist, please check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.