DescribeRtcCloudTranscode - - Alibaba Cloud Documentation Center

Retrieves the details of an RTC cloud 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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID. The ID can contain uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-). The ID can be up to 64 characters in length.	******-7074--9ef5-85c19a4***
TaskId	string	Yes	The ID of the cloud transcoding job. The ID can contain uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-). The ID can be up to 64 characters in length.	****73-8501--8ac1-72295a****

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	****3B-0E1A-586A-AC29-742247****
TaskInfo	object	The details of the cloud transcoding job.
AppId	string	The application ID.	******-7074--9ef5-85c19a4***
ChannelId	string	The channel ID.	myChannel
TaskId	string	The ID of the cloud transcoding job.	****73-8501--8ac1-72295a****
Status	string	The status of the cloud transcoding job: STARTING RUNNING RECOVERING STOPPED	RUNNING
InputParam	object	The parameters for the subscribed input stream.
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 parameters for the transcoded output.
	object	The parameters for the transcoded output.
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.	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.