GetEdgeTranscodeTemplate API Reference - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Queries the details of an edge transcoding template.

Operation description

This operation queries the details of an edge transcoding template.
You must have permissions to access the edge transcoding service before you can call this operation.

QPS limit

The single-user QPS limit for this operation is 6,000 calls per minute. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation as needed.

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

get

*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****
TemplateId	string	Yes	The template ID.	**a046-263c-3560-978a-fb287666**

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	****3B-0E1A-586A-AC29-742247****
Template	object	The edge transcoding template.
Bitrate	string	The bitrate configuration. Valid values: a fixed bitrate value or ws (follow source).	3000
Codec	string	The video encoding format. Valid values: H.264. H.265.	H.264
CreateTime	string	The time when the template was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2023-07-25T02:48:58Z
Fps	string	The frame rate configuration. Valid values: a fixed frame rate value or ws (follow source).	30
Gop	string	The keyframe configuration. Valid values: frame-based, second-based, or ws (follow source).	2s
Name	string	The template name.	my_template
Resolution	string	The resolution configuration. Valid values: a fixed resolution value or ws (follow source). Note When a fixed resolution is used and width or height is set to -1 or -2, the width or height is adaptive.	1920*1080
TemplateId	string	The template ID.	9b1571b513cb44f7a1ba6ae561ff****
Type	string	The edge transcoding type.	common

Examples

Success response

JSON format

{
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "Template": {
    "Bitrate": "3000",
    "Codec": "H.264",
    "CreateTime": "2023-07-25T02:48:58Z",
    "Fps": "30",
    "Gop": "2s",
    "Name": "my_template",
    "Resolution": "1920*1080",
    "TemplateId": "9b1571b513cb44f7a1ba6ae561ff****",
    "Type": "common"
  }
}

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	TemplateNotFound	%s, please check and try again later.	The template does not exist. Please check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.