DescribeRtcCloudTranscode

Queries a cloud transcoding task.

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

none

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID. The value can contain uppercase and lowercase letters, digits, underscores, and hyphens (-), with a maximum of 64 characters.	******-7074--9ef5-85c19a4***
TaskId	string	Yes	The cloud transcoding task ID. The value can contain uppercase and lowercase letters, digits, underscores, and hyphens (-), with a maximum of 64 characters.	****73-8501--8ac1-72295a****

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	****3B-0E1A-586A-AC29-742247****
TaskInfo	object	The details of the cloud transcoding task.
AppId	string	The application ID.	******-7074--9ef5-85c19a4***
ChannelId	string	The channel ID.	myChannel
TaskId	string	The cloud transcoding task ID.	****73-8501--8ac1-72295a****
Status	string	The status of the cloud transcoding task. Valid values: STARTING RUNNING RECOVERING STOPPED.	RUNNING
InputParam	object	The subscription input parameters.
SingleSubUserParam	object	The input parameters for subscribing to a single stream.
UserId	string	The ID of the user to subscribe to.	userA
StreamType	integer	The media type of the subscribed user's stream.	0
SourceType	integer	The type of the subscribed video input stream.	0
OutputParams	array<object>	The transcoding output parameters.
	object	The transcoding output parameter.
ChannelId	string	The ID of the channel to which the transcoded stream is pushed.	myChannel
UserId	string	The user ID used to push the transcoded stream to the channel.	userA_360p
UserToken	string	The user token required to push the transcoded stream to the channel.	eyJhcHBpZCI********
TranscodeTemplate	string	The name of the transcoding template.	lhd
MaxIdleTime	integer	The idle timeout period. If the task remains idle for longer than the MaxIdleTime value, the task is automatically stopped. Unit: seconds. Valid values: 10 to 14400 (maximum of 4 hours). Default value: 300.	600

Examples

Success response

JSON format

{
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "TaskInfo": {
    "AppId": "********-7074-****-9ef5-85c19a4*****",
    "ChannelId": "myChannel",
    "TaskId": "******73-8501-****-8ac1-72295a******",
    "Status": "RUNNING",
    "InputParam": {
      "SingleSubUserParam": {
        "UserId": "userA",
        "StreamType": 0,
        "SourceType": 0
      }
    },
    "OutputParams": [
      {
        "ChannelId": "myChannel",
        "UserId": "userA_360p",
        "UserToken": "eyJhcHBpZCI********",
        "TranscodeTemplate": "lhd"
      }
    ],
    "MaxIdleTime": 600
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter%s	%s.
400	MissingParameter%s	%s.
400	TooManyRequests	%s.
500	InternalError	%s.	error on the live liveapi server.
403	Forbidden	%s.
404	NotFound%s	%s.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.