SearchTemplate - ApsaraVideo Media Processing - Alibaba Cloud Documentation Center

You can call this operation to query custom transcoding templates in the specified state.

Operation description

You can call this operation up to 100 times per second. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see QPS limit.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
PageSize	long	No	The size of each page set during the result paging query. Upper limit: 100. Default value: 10.	10
PageNumber	long	No	The number of the page to return. Default value: 1.	1
State	string	No	The status of the custom transcoding templates that you want to query. All: All custom transcoding templates are queried. Normal: Normal custom transcoding templates are queried. Deleted: Deleted custom transcoding templates are queried. Default value: All.	Normal
NamePrefix	string	No	The name prefix based on which you want to search for templates.	S00000001

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
TotalCount	long	The total number of search results.	1
TemplateList	object []	The transcoding templates.
Video	object	The video codec configurations.
Bufsize	string	The buffer size. Unit: KB. Default value: 6000.	6000
LongShortMode	string	Indicates whether the auto-rotate screen feature is enabled. If this feature is enabled, the width of the output video corresponds to the long side of the input video, which is the height of the input video in portrait mode. The height of the output video corresponds to the short side of the input video, which is the width of the input video in portrait mode. Valid values: true false Default value: false.	false
Degrain	string	The level of video quality control.	10
BitrateBnd	object	The average bitrate range of the video.
Max	string	The upper limit of the total bitrate. Unit: Kbit/s.	500
Min	string	The lower limit of the total bitrate. Unit: Kbit/s.	100
PixFmt	string	The pixel format of the video. Valid values: standard pixel formats such as yuv420p and yuvj420p.	yuv420p
Pad	string	The black bars that are added to the video. Format: width:height:left:top. Example: 1280:800:0:140.	1280:800:0:140
Codec	string	The codec. Valid values: H.264 and H.265. Default value: H.264.	H.264
Height	string	The video height. Unit: pixel. Default value: the height of the input video.	800
Qscale	string	The strength of the independent denoising algorithm.	1
Crop	string	The method of video cropping. Valid values: border: automatically detects and removes black bars. Value in the width:height:left:top format: crops the video image based on the custom modes. Example: 1280:800:0:140.	border
Bitrate	string	The average bitrate of the video. Unit: Kbit/s.	200
Maxrate	string	The maximum bitrate of the video. Unit: Kbit/s.	500
MaxFps	string	The maximum frame rate.	60
Profile	string	The codec profile. Valid values: baseline: applicable to mobile devices. main: applicable to standard-definition devices. high: applicable to high-definition devices. Default value: high.	high
Crf	string	The constant rate factor. Default value when the encoding format is H.264: 23, default value when the encoding format is H.265: 26. If this parameter is specified, the setting of Bitrate becomes invalid.	15
Remove	string	Indicates whether the video stream is deleted. Valid values: true false Default value: false.	false
Gop	string	The maximum number of frames between two keyframes. Default value: 250.	10
Width	string	The video width. Valid values: [128,4096]. Unit: pixel. Default value: the width of the input video.	256
Fps	string	The frame rate of the transcoded video. The value is 60 if the frame rate of the input file exceeds 60. Default value: the frame rate of the input video.	25
Preset	string	The preset video algorithm. Default value: medium. Valid values: veryfast fast medium slow slower	medium
ScanMode	string	The scan mode. Valid values: interlaced progressive	interlaced
ResoPriority	string	The policy of resolution adjustment. Valid values: cropFirst, widthFirst, and heightFirst.	heightFirst
TransConfig	object	The general transcoding configurations.
IsCheckAudioBitrate	string	Indicates whether the audio bitrate is checked. If the bitrate of the output audio is higher than that of the input audio, the input bitrate is retained and the specified audio bitrate does not take effect. This parameter has a lower priority than IsCheckAudioBitrateFail. Valid values: true false Default value: If this parameter is not specified and the codec of the output audio is different from that of the input audio, the default value is false. If this parameter is not specified and the codec of the output audio is the same as that of the input audio, the default value is true.	false
TransMode	string	The transcoding mode. Default value: onepass. Valid values: onepass twopass CBR	onepass
IsCheckReso	string	Indicates whether the resolution is checked. If the output resolution is higher than the input resolution based on the width or height, the input resolution is retained. Valid values: true false Default value: false.	false
IsCheckVideoBitrateFail	string	Indicates whether video bitrate check errors are allowed. This parameter has a higher priority than IsCheckVideoBitrate. Valid values: true: If the video bitrate check fails, the input file is not transcoded. false: The video bitrate is not checked. Default value: false.	false
AdjDarMethod	string	The method of resolution adjustment. Default value: none. Valid values: rescale crop none	none
IsCheckVideoBitrate	string	Indicates whether the video bitrate is checked. If the bitrate of the output video is higher than that of the input video, the input bitrate is retained. Valid values: true false Default value: false.	false
IsCheckResoFail	string	Indicates whether the resolution is checked. If the output resolution is higher than the input resolution based on the width or height, a transcoding failure is returned. Valid values: true false Default value: false.	false
IsCheckAudioBitrateFail	string	Indicates whether audio bitrate check errors are allowed. This parameter has a greater priority than IsCheckAudioBitrate. Valid values: true: If the audio bitrate check fails, the input file is not transcoded. false: The audio bitrate is not checked. Default value: false.	false
State	string	The template state. Valid values: Normal Deleted	Normal
MuxConfig	object	The transmuxing configurations.
Gif	object	The transmuxing configurations for GIF.
FinalDelay	string	The duration for which the final frame is paused. Unit: centisecond.	0
DitherMode	string	The color dithering algorithm of the palette. Valid values: sierra and bayer.	sierra
Loop	string	The loop count.	0
IsCustomPalette	string	Indicates whether the custom palette is used.	false
Segment	object	The segment configurations.
Duration	string	The segment length. Unit: seconds.	10
Name	string	The template name.	MPS-example
Audio	object	The audio codec configurations.
Profile	string	The codec profile of the audio. Valid values when the value of Codec is aac: aac_low aac_he aac_he_v2 aac_ld aac_eld	aac_low
Remove	string	Indicates whether the audio stream is deleted. Valid values: true false Default value: false.	false
Codec	string	The audio codec. Default value: aac. Valid values: aac mp3 vorbis flac	aac
Samplerate	string	The sampling rate of the audio stream. Unit: Hz. Default value: 44100.	44100
Qscale	string	The strength of the independent denoising algorithm. Valid values: [1,9].	1
Channels	string	The number of sound channels. Default value: 2.	2
Bitrate	string	The audio bitrate of the output file. Unit: Kbit/s. Default value: 128.	500
Id	string	The transcoding template ID.	16f01ad6175e4230ac42bb5182cd****
Container	object	The container format configurations.
Format	string	The container format. Valid values: flv mp4 ts m3u8 gif mp3 ogg flac	mp4
CreationTime	string	The time when the template was created.	2021-03-04T06:44:43Z
PageSize	long	The page number of the returned page.	10
RequestId	string	The ID of the request.	BC860F04-778A-472F-AB39-E1BF329C****
PageNumber	long	The number of the page to return.	1

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "TemplateList": {
    "Template": [
      {
        "Video": {
          "Bufsize": "6000",
          "LongShortMode": "false",
          "Degrain": "10",
          "BitrateBnd": {
            "Max": "500",
            "Min": "100"
          },
          "PixFmt": "yuv420p",
          "Pad": "1280:800:0:140",
          "Codec": "H.264",
          "Height": "800",
          "Qscale": "1",
          "Crop": "border",
          "Bitrate": "200",
          "Maxrate": "500",
          "NarrowBand": {
            "Abrmax": 0,
            "MaxAbrRatio": 0,
            "Version": ""
          },
          "MaxFps": "60",
          "Profile": "high",
          "Crf": "15",
          "Remove": "false",
          "Gop": "10",
          "Width": "256",
          "Fps": "25",
          "Preset": "medium",
          "ScanMode": "interlaced",
          "ResoPriority": "heightFirst",
          "Hdr2sdr": ""
        },
        "TransConfig": {
          "IsCheckAudioBitrate": "false",
          "TransMode": "onepass",
          "IsCheckReso": "false",
          "IsCheckVideoBitrateFail": "false",
          "AdjDarMethod": "none",
          "IsCheckVideoBitrate": "false",
          "IsCheckResoFail": "false",
          "IsCheckAudioBitrateFail": "false"
        },
        "State": "Normal",
        "MuxConfig": {
          "Gif": {
            "FinalDelay": "0",
            "DitherMode": "sierra",
            "Loop": "0",
            "IsCustomPalette": "false"
          },
          "Segment": {
            "Duration": "10"
          }
        },
        "Name": "MPS-example",
        "Audio": {
          "Profile": "aac_low",
          "Remove": "false",
          "Codec": "aac",
          "Samplerate": "44100",
          "Qscale": "1",
          "Channels": "2",
          "Bitrate": "500"
        },
        "Id": "16f01ad6175e4230ac42bb5182cd****",
        "Container": {
          "Format": "mp4"
        },
        "CreationTime": "2021-03-04T06:44:43Z"
      }
    ]
  },
  "PageSize": 10,
  "RequestId": "BC860F04-778A-472F-AB39-E1BF329C****",
  "PageNumber": 1
}

Error codes

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

Change history

Change time

Summary of changes

Operation

2024-03-14

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2024-01-04

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-09-21

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-07-13

The request parameters of the API has changed. The response structure of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: NamePrefix
Output Parameters	The response structure of the API has changed.