tencent cloud

Querying Templates
Last updated: 2025-09-09 20:46:31
Querying Templates
Last updated: 2025-09-09 20:46:31

Feature Description

query template.

Authorization Description

When used by a sub-account, the ci:DescribeMediaTemplates permission is required. For details, see Cloud Infinite action.

Service Activation

Using this feature requires enabling Cloud Infinite in advance and binding a bucket. For details, see Binding a Bucket.

Use Limits

When using this API, please confirm the relevant restrictions first. For details, see Usage Limits.


Request

Request sample

GET /template HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Content-Type: application/xml
Note:
Authorization: Auth String. For details, see Request Signature document.

Request header

This API only uses common request headers. For details, see Common Request Headers documentation.

Request body

The request does not have a request body.

Request parameters

The specific content of the parameter is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required
tag
None.
Template type, default value: All
String
No
category
None.
Official (system preset template) Custom (custom template) Default value: Custom
String
No
ids
None.
template ID, split the string with the , symbol
String
No
name
None.
template name prefix
String
No
pageNumber
None.
Which page, default value: 1
Integer
No
pageSize
None.
Number of items per page, default value: 10
Integer
No
tag supports the following types:
Template Type
tag
audio and video transcoding
Transcode
Convert video to GIF
Animation
Video screenshot
Snapshot
intelligent cover
SmartCover
Audio/Video splicing
Concat
Voice separation
VoiceSeparate
highlights
VideoMontage
video enhancement
VideoProcess
Super resolution
SuperResolution
Image/Text watermark
Watermark
Text To Speech (TTS)
Tts
Audio and Video Transcoding Pro
TranscodePro
Top Speed Codec (TSC)
HighSpeedHd
Image Processing
PicProcess
Automatic Speech Recognition (ASR)
SpeechRecognition
Video object detection
VideoTargetRec

Response

Response Headers

This API only returns the public response header. For details, see Common Response Headers documentation.

Response Body

The response body is returned as application/xml. An example including the complete node data is shown below:
<Response>
<RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhfMjc=</RequestId>
<TotalCount>1</TotalCount>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<TemplateList>
<TemplateId>A</TemplateId>
<Name>TemplateName</Name>
<Tag>Transcode</Tag>
<TransTpl>
<Container>
<Format>mp4</Format>
</Container>
<Video>
<Codec>H.264</Codec>
<Profile>high</Profile>
<Bitrate>1000</Bitrate>
<Width>1280</Width>
<Fps>30</Fps>
<Preset>medium</Preset>
</Video>
<Audio>
<Codec>aac</Codec>
<Samplerate>44100</Samplerate>
<Bitrate>128</Bitrate>
<Channels>4</Channels>
</Audio>
<TransConfig>
<AdjDarMethod>scale</AdjDarMethod>
<IsCheckReso>false</IsCheckReso>
<ResoAdjMethod>1</ResoAdjMethod>
</TransConfig>
<TimeInterval>
<Start>0</Start>
<Duration>60</Duration>
</TimeInterval>
</TransTpl>
<CreateTime>2020-08-05T11:35:24+0800</CreateTime>
<UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
</TemplateList>
</Response>
The data are as follows:
Node Name (Keyword)
Parent Node
Description
Type
Response
None.
Container for saving results
Container
Container node Response content:
Node Name (Keyword)
Parent Node
Description
Type
RequestId
Response
unique request ID
String
TotalCount
Response
Total number of templates
Int
PageNumber
Response
current page number, same as the pageNumber in the request
Int
PageSize
Response
number of items per page, same as the pageSize in the request
Int
TemplateList
Response
template array
Container array
For different template types, the content of TemplateList is the same as the Response of the template creation API. See the following link:

Error Codes

This request returns common error responses and error codes. For more information, see Error Codes.

Examples

Case 1: Query by template ID dimension

Request

GET /template?ids=t1847cd4ca57f543e89f551dbe68169eb9,t1a30a323f55434a29b25bf2a16bdf5f59,C HTTP/1.1
Authorization: q-sign-algorithm=sha1&q-ak=**********************************&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=**************************************
Host: test-1234567890.ci.ap-beijing.myqcloud.com
Content-Length: 0
Content-Type: application/xml

Response

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 100
Connection: keep-alive
Date: Thu, 14 Jul 2022 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****

<Response>
<RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId>
<TemplateList>
<TemplateId>t1847cd4ca57f543e89f551dbe68169eb9</TemplateId>
<Name>TemplateName</Name>
<Tag>Transcode</Tag>
<BucketId>test-1234567890</BucketId>
<Category>Custom</Category>
<TransTpl>
<Container>
<Format>mp4</Format>
</Container>
<Video>
<Codec>H.264</Codec>
<Profile>high</Profile>
<Bitrate>1000</Bitrate>
<Width>1280</Width>
<Fps>30</Fps>
<Preset>medium</Preset>
</Video>
<Audio>
<Codec>aac</Codec>
<Samplerate>44100</Samplerate>
<Bitrate>128</Bitrate>
<Channels>4</Channels>
</Audio>
<TransConfig>
<AdjDarMethod>scale</AdjDarMethod>
<IsCheckReso>false</IsCheckReso>
<ResoAdjMethod>1</ResoAdjMethod>
</TransConfig>
<TimeInterval>
<Start>0</Start>
<Duration>60</Duration>
</TimeInterval>
</TransTpl>
<CreateTime>2020-08-05T11:35:24+0800</CreateTime>
<UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
</TemplateList>
<TemplateList>
<TemplateId>t140325e8918ac423da53b7d78dbbab564</TemplateId>
<Name>template_name3544697</Name>
<Tag>Concat</Tag>
<BucketId>test-1234567890</BucketId>
<Category>Custom</Category>
<ConcatTemplate>
<ConcatFragment>
<Mode>Start</Mode>
<Url>https://test-1234567890.cos.ap-chongqing.myqcloud.com/input/ad.mp4</Url>
</ConcatFragment>
<Audio>
<Codec>aac</Codec>
<Samplerate/>
<Bitrate/>
<Channels/>
<Remove>false</Remove>
</Audio>
<Video>
<Codec>H.264</Codec>
<Width>1280</Width>
<Height>960</Height>
<Fps>15</Fps>
<Remove>false</Remove>
<Crf>25</Crf>
</Video>
<Container>
<Format>mp4</Format>
</Container>
<DirectConcat>false</DirectConcat>
</ConcatTemplate>
<CreateTime>2022-06-29T14:37:44+0800</CreateTime>
<UpdateTime>2022-06-29T14:37:44+0800</UpdateTime>
</TemplateList>
<NonExistTIDs>
<TemplateId>C</TemplateId>
</NonExistTIDs>
</Response>
Case 2: Query by pagination list dimension

Request

GET /template?pageSize=10&pageNumber=1 HTTP/1.1
Authorization: q-sign-algorithm=sha1&q-ak=**********************************&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=**************************************
Host: test-1234567890.ci.ap-beijing.myqcloud.com
Content-Length: 0
Content-Type: application/xml

Response

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 100
Connection: keep-alive
Date: Thu, 14 Jul 2022 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****

<Response>
<RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId>
<TotalCount>2</TotalCount>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<TemplateList>
<TemplateId>t1847cd4ca57f543e89f551dbe68169eb9</TemplateId>
<Name>TemplateName</Name>
<Tag>Transcode</Tag>
<TransTpl>
<Container>
<Format>mp4</Format>
</Container>
<Video>
<Codec>H.264</Codec>
<Profile>high</Profile>
<Bitrate>1000</Bitrate>
<Width>1280</Width>
<Fps>30</Fps>
<Preset>medium</Preset>
</Video>
<Audio>
<Codec>aac</Codec>
<Samplerate>44100</Samplerate>
<Bitrate>128</Bitrate>
<Channels>4</Channels>
</Audio>
<TransConfig>
<AdjDarMethod>scale</AdjDarMethod>
<IsCheckReso>false</IsCheckReso>
<ResoAdjMethod>1</ResoAdjMethod>
</TransConfig>
<TimeInterval>
<Start>0</Start>
<Duration>60</Duration>
</TimeInterval>
</TransTpl>
<CreateTime>2020-08-05T11:35:24+0800</CreateTime>
<UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
</TemplateList>
<TemplateList>
<TemplateId>t140325e8918ac423da53b7d78dbbab564</TemplateId>
<Name>template_name3544697</Name>
<Tag>Concat</Tag>
<BucketId>test-1234567890</BucketId>
<Category>Custom</Category>
<ConcatTemplate>
<ConcatFragment>
<Mode>Start</Mode>
<Url>https://test-1234567890.cos.ap-chongqing.myqcloud.com/input/ad.mp4</Url>
</ConcatFragment>
<Audio>
<Codec>aac</Codec>
<Samplerate/>
<Bitrate/>
<Channels/>
<Remove>false</Remove>
</Audio>
<Video>
<Codec>H.264</Codec>
<Width>1280</Width>
<Height>960</Height>
<Fps>15</Fps>
<Remove>false</Remove>
<Crf>25</Crf>
</Video>
<Container>
<Format>mp4</Format>
</Container>
<DirectConcat>false</DirectConcat>
</ConcatTemplate>
<CreateTime>2022-06-29T14:37:44+0800</CreateTime>
<UpdateTime>2022-06-29T14:37:44+0800</UpdateTime>
</TemplateList>
</Response>

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback