GetLiveTranscodeJob - - Alibaba Cloud Documentation Center

Queries the information about a live stream transcoding job.

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

ice:GetLiveTranscodeJob

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobId	string	Yes	The ID of the transcoding job.	**20b48fb04483915d4f2cd8ac**

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	****3B-0E1A-586A-AC29-742247****
Job	object	The information about the transcoding job.
Name	string	The name of the transcoding job.	task1
JobId	string	The ID of the transcoding job.	**20b48fb04483915d4f2cd8ac**
TemplateType	string	The type of the template.	normal
TemplateId	string	The template ID.	b6491d5b3e514b7d895d14b5453ea119
TemplateName	string	The template name.	basic
StartMode	integer	The start mode of the job.	0
Status	integer	The state of the job. 0: The job is not started. 1: The job is in progress. 2: The job is stopped.	1
StreamInput	object	The information about the input stream.
Type	string	The type of the input stream.	rtmp
InputUrl	string	The URL of the input stream.	rtmp://mydomain/app/stream1
OutputStream	object	The information about the output stream.
StreamInfos	array<object>	The information about the output stream.
	object
Type	string	The type of the output stream protocol. Only the RTMP protocol is supported.	rtmp
OutputUrl	string	The URL of the output stream.	rtmp://mydomain/app/mytranscode1
CreateTime	string	The time when the job was created.	2022-07-20T02:48:58Z

Examples

Success response

JSON format

{
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "Job": {
    "Name": "task1",
    "JobId": "****20b48fb04483915d4f2cd8ac****",
    "TemplateType": "normal",
    "TemplateId": "b6491d5b3e514b7d895d14b5453ea119",
    "TemplateName": "basic",
    "StartMode": 0,
    "Status": 1,
    "StreamInput": {
      "Type": "rtmp",
      "InputUrl": "rtmp://mydomain/app/stream1"
    },
    "OutputStream": {
      "StreamInfos": [
        {
          "Type": "rtmp",
          "OutputUrl": "rtmp://mydomain/app/mytranscode1"
        }
      ]
    },
    "CreateTime": "2022-07-20T02:48:58Z"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Forbidden	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.