ListEdgeTranscodeTemplate - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the list of edge transcoding templates.

Operation description

You can call this operation to query the list of edge transcoding templates.
To call this operation, make sure that you have the permissions to access the edge transcoding feature.

QPS limit

You can call this operation up to 6,000 times per minute per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
live:ListEdgeTranscodeTemplate		Domain `acs:live::{#accountId}:domain/{#DomainName}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the data center.	****3b-4d18-395c-8106-ff21a6****
Type	string	No	The type of edge transcoding. Valid values: common: standard transcoding and Narrowband HD™ 1.0 transcoding. nbhd-2: Narrowband HD™ 2.0 transcoding. ultra-hd: ultra-high definition transcoding. Note If you do not specify this parameter, the query result is filtered based on the type of edge transcoding on which you are granted permissions.	nbhd-2
VideoCodec	string	No	The video encoding format. Valid values: H.264 H.265 Note If you do not specify this parameter, the query result is filtered based on the video encoding format on which you are granted permissions.	H.264
PageNo	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	20
SortBy	string	No	The sorting order of the templates by creation time. Default value: desc. Valid values: desc: descending order. asc: ascending order.	desc
Keyword	string	No	The keyword of the query. You can specify a template ID for an exact match. You can also specify a template name for a fuzzy match.	baseline

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	****3B-0E1A-586A-AC29-742247****
TemplateList	array<object>	The details of the edge transcoding templates.
Template	object	The details of the edge transcoding templates.
Bitrate	string	The bitrate. If a numeric value is returned, a fixed bitrate is configured for the output stream. If ws is returned, the output stream maintains the same bitrate as the input stream.	3000
Codec	string	The video encoding format. Valid values: H.264 H.265	H.264
CreateTime	string	The time when the image template was created.	2023-07-25T02:48:58Z
Fps	string	The frame rate. If a numeric value is returned, a fixed frame rate is configured for the output stream. If ws is returned, the output stream maintains the same frame rate as the input stream.	30
Gop	string	The group of pictures (GOP) size. The GOP size can be defined by the number of frames or the time interval between I-frames. If ws is returned, the output stream maintains the same GOP size as the input stream.	2s
Name	string	The template name.	my_template
Resolution	string	The resolution. If width and height values are returned, a fixed resolution is configured for the output stream. If ws is returned, the output stream maintains the same resolution as the input stream. Note If the width value is -1, the width of the output video is adapted to a fixed height. If the height value is -2, the height of the output video is adapted to a fixed width.	1920*1080
TemplateId	string	The ID of the edge transcoding template.	9b1571b513cb44f7a1ba6ae561ff46f7
Type	string	The type of edge transcoding.	common
TotalCount	integer	The total number of templates returned.	100

Examples

Sample success responses

JSONformat

{
  "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
400	InvalidParameter	%s
400	MissingParameter	%s
403	OperationDenied	%s

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history