List Edge Transcoding Templates with ListEdgeTranscodeTemplate API - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Queries the list of edge transcoding templates.

Operation description

This operation queries the list of edge transcoding templates.
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:ListEdgeTranscodeTemplate

list

*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****
Type	string	No	The edge transcoding type. Valid values: common: default transcoding (standard + Narrowband HD 1.0). nbhd-2: Narrowband HD 2.0. ultra-hd: ultra-high definition. Note If this parameter is not specified, the system displays transcoding templates for the transcoding types that the user has permissions to access.	nbhd-2
VideoCodec	string	No	The video encoding format. Valid values: H.264. H.265. Note If this parameter is not specified, the system displays transcoding templates for the video encoding formats that the user has permissions to access.	H.264
PageNo	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	20
SortBy	string	No	The sorting rule. Templates are sorted by creation time (CreateTime). Default value: desc. Valid values: desc: descending order. asc: ascending order.	desc
Keyword	string	No	The search keyword. Valid values: Template ID. Exact match is supported. Template name. Fuzzy match is supported.	baseline

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	****3B-0E1A-586A-AC29-742247****
TemplateList	object
Template	array<object>	The list of edge transcoding templates.
	object	The list of edge transcoding templates.
Bitrate	string	The bitrate configuration. The bitrate can be fixed or can follow the source stream.	3000
Codec	string	The video encoding format. Valid values: H.264. H.265.	H.264
CreateTime	string	The time when the template was created.	2023-07-25T02:48:58Z
Fps	string	The frame rate configuration. The frame rate can be fixed or can follow the source stream.	30
Gop	string	The keyframe configuration. You can configure keyframes by frame, by second, or set keyframes to follow the source stream.	2s
Name	string	The template name.	my_template
Resolution	string	The resolution configuration. The resolution can be fixed or can follow the source stream. Note If you set a fixed resolution, setting the width or height to -1 or -2 indicates that the width or height is adaptive.	1920*1080
TemplateId	string	The template ID.	9b1571b513cb44f7a1ba6ae561ff46f7
Type	string	The edge transcoding type.	common
TotalCount	integer	The total number of entries.	100

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	%s.	Parameter error
400	MissingParameter	%s.	Missing parameter
403	OperationDenied	%s, please check and try again later.	Operation rejected, please check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.