All Products
Search
Document Center

Intelligent Media Services:ListLiveTranscodeTemplates

Last Updated:Dec 16, 2024

Queries a list of live stream transcoding templates.

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
ice:ListLiveTranscodeTemplates
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TypestringNo

The type of the template. Valid values:

  • normal
  • narrow-band
  • audio-only
  • origin
normal
VideoCodecstringNo

The video codec. Valid values:

  • H.264
  • H.265
H.264
PageNointegerNo

The page number of the page to return. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Default value: 10. Maximum value: 100.

20
SortBystringNo

The sorting order. By default, the query results are sorted by creation time in descending order. Valid values:

  • asc
  • desc
asc
KeyWordstringNo

The search keyword. You can use the template ID or name as the keyword to search for templates. If you search for templates by name, fuzzy match is supported.

my_template
CategorystringNo

The category of the template. Valid values:

  • system
  • customized
customized

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

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

The total number of entries returned.

100
TemplateContentListarray<object>

The list of transcoding templates.

templateContentobject
Namestring

The template name.

my_template
TemplateIdstring

The template ID.

9b1571b513cb44f7a1ba6ae561ff46f7
Typestring

The type of the template.

normal
Categorystring

The category of the template. Valid values:

system
CreateTimestring

The time when the job was created.

2022-07-20T03:26:36Z
TemplateConfigobject

The configuration of the template.

VideoParamsobject

The video parameters.

Codecstring

The encoding format.

264
Heightstring

The vertical resolution of the video.

1280
Widthstring

The horizontal resolution of the video.

720
Fpsstring

The video frame rate.

30
Bitratestring

The video bitrate.

2500
Gopstring

The group of pictures (GOP) of the output video. Unit: frame.

1000
Profilestring

The encoding profile.

3
AudioParamsobject

The audio parameters.

Codecstring

The audio codec.

AAC
Bitratestring

The audio bitrate.

1000
Sampleratestring

The audio sampling rate.

44100
Channelsstring

The number of sound channels.

2
Profilestring

The encoding profile.

aac_low

Examples

Sample success responses

JSONformat

{
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "TotalCount": 100,
  "TemplateContentList": [
    {
      "Name": "my_template",
      "TemplateId": "9b1571b513cb44f7a1ba6ae561ff46f7",
      "Type": "normal",
      "Category": "system",
      "CreateTime": "2022-07-20T03:26:36Z",
      "TemplateConfig": {
        "VideoParams": {
          "Codec": "264",
          "Height": "1280",
          "Width": "720",
          "Fps": "30",
          "Bitrate": "2500",
          "Gop": "1000",
          "Profile": "3"
        },
        "AudioParams": {
          "Codec": "AAC",
          "Bitrate": "1000",
          "Samplerate": "44100",
          "Channels": "2",
          "Profile": "aac_low"
        }
      }
    }
  ]
}

Error codes

HTTP status codeError codeError message
403OperationDeniedYour account has not enabled the ICE service.

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