All Products
Search
Document Center

ApsaraVideo Live:GetEdgeTranscodeTemplate

Last Updated:Dec 09, 2024

Queries the details of an edge transcoding template.

Operation description

  • You can call this operation to query the details of an edge transcoding template.
  • 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
live:GetEdgeTranscodeTemplate
*Domain
acs:live:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The ID of the data center.

******3b-4d18-395c-8106-ff21a6******
TemplateIdstringYes

The template ID.

****a046-263c-3560-978a-fb287666****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

******3B-0E1A-586A-AC29-742247******
Templateobject

The details of the edge transcoding template.

Bitratestring

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
Codecstring

The video encoding format. Valid values:

  • H.264
  • H.265
H.264
CreateTimestring

The time when the template was created.

2023-07-25T02:48:58Z
Fpsstring

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
Gopstring

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
Namestring

The template name.

my_template
Resolutionstring

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 stream is adapted to the height. If the height value is -2, the height of the output stream is adapted to the width.
1920*1080
TemplateIdstring

The template ID.

9b1571b513cb44f7a1ba6ae561ff****
Typestring

The type of edge transcoding.

common

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError message
400MissingParameter%s
403OperationDenied%s
404TemplateNotFound%s

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

Change history

Change timeSummary of changesOperation
No change history