This API (DescribeMediaTemplates
) is used to search for video montage templates.
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 more information, please see Request Signature.)
This API only uses Common Request Headers.
The request body of this request is empty.
The nodes are described as follows:
Node Name (Keyword) | Parent Node | Description | Type | Required |
---|---|---|---|---|
Tag | None | Task type: VideoMontage | String | Yes |
Category | None | Template category: Custom (default) or Official | String | Yes |
Ids | None | Template ID. If you enter multiple IDs, separate them with commas (,). | String | No |
Name | None | Template name prefix | String | No |
PageNumber | None | Page number | Integer | No |
PageSize | None | Records per page | Integer | No |
This API only returns Common Response Headers.
The response body returns application/xml data. The following contains all the nodes:
<Response>
<RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhfMjc=</RequestId>
<TotalCount>1</TotalCount>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<TemplateList>
<TemplateId>A</TemplateId>
<Name>TemplateName</Name>
<Tag>VideoMontage</Tag>
<VideoMontage>
<Duration></Duration>
<Container>
<Format>mp4</Format>
</Container>
<Video>
<Codec>H.264</Codec>
<Bitrate>1000</Bitrate>
<Width>1280</Width>
<Height></Height>
<Fps>30</Fps>
</Video>
<Audio>
<Codec>aac</Codec>
<Samplerate>44100</Samplerate>
<Bitrate>128</Bitrate>
<Channels>4</Channels>
<Remove>false</Remove>
</Audio>
</VideoMontage>
<CreateTime>2020-08-05T11:35:24+0800</CreateTime>
<UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
</TemplateList>
</Response>
The nodes are described as follows:
Node Name (Keyword) | Parent Node | Description | Type |
---|---|---|---|
Response | None | Response container | Container |
Response
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type |
---|---|---|---|
RequestId | Response | Unique ID of the request | String |
TotalCount | Response | Total number of templates | Int |
PageNumber | Response | Current page number. Same as pageNumber in the request. |
Int |
PageSize | Response | Number of records per page. Same as pageSize in the request. |
Int |
TemplateList | Response | Template array | Container |
TemplateList
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type |
---|---|---|---|
TemplateId | Response.TemplateList | Template ID | String |
Name | Response.TemplateList | Template name | String |
BucketId | Response.TemplateList | Template bucket | String |
Category | Response.TemplateList | Template category: Custom or Official | String |
Tag | Response.TemplateList | Task type: VideoMontage | String |
UpdateTime | Response.TemplateList | Update time | String |
CreateTime | Response.TemplateList | Creation time | String |
VideoMontage | Response.TemplateList | Template parameters | Container |
VideoMontage
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type |
---|---|---|---|
Container | Response.TemplateList.VideoMontage | Same as Request.Container in the video montage template creation API CreateMediaTemplate . |
Container |
Duration | Response.TemplateList.VideoMontage | Same as Request.Duration in the video montage template creation API CreateMediaTemplate . |
String |
Video | Response.TemplateList.VideoMontage | Same as Request.Video in the video montage template creation API CreateMediaTemplate . |
Container |
Audio | Response.TemplateList.VideoMontage | Same as Request.Audio in the video montage template creation API CreateMediaTemplate . |
Container |
No special error message will be returned for this request. For the common error messages, please see Error Codes.
GET /template?ids=A,B,C HTTP/1.1
Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0e****
Host: examplebucket-1250000000.ci.ap-beijing.myqcloud.com
Content-Length: 0
Content-Type: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 100
Connection: keep-alive
Date: Thu, 15 Jun 2017 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
<Response>
<RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId>
<TemplateList>
<TemplateId>A</TemplateId>
<Name>TemplateName</Name>
<Tag>VideoMontage</Tag>
<VideoMontage>
<Duration></Duration>
<Container>
<Format>mp4</Format>
</Container>
<Video>
<Codec>H.264</Codec>
<Bitrate>1000</Bitrate>
<Width>1280</Width>
<Height></Height>
</Video>
<Audio>
<Codec>aac</Codec>
<Samplerate>44100</Samplerate>
<Bitrate>128</Bitrate>
<Channels>4</Channels>
<Remove>false</Remove>
</Audio>
</VideoMontage>
<CreateTime>2020-08-05T11:35:24+0800</CreateTime>
<UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
</TemplateList>
<NonExistTIDs>
<TemplateId>B</TemplateId>
<TemplateId>C</TemplateId>
</NonExistTIDs>
</Response>
GET /template?pageSize=10&pageNumber=1 HTTP/1.1
Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0**********&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0ea057
Host: examplebucket-1250000000.ci.ap-beijing.myqcloud.com
Content-Length: 0
Content-Type: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 100
Connection: keep-alive
Date: Thu, 15 Jun 2017 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
<Response>
<RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId>
<TotalCount>1</TotalCount>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<TemplateList>
<TemplateId>A</TemplateId>
<Name>TemplateName</Name>
<Tag>VideoMontage</Tag>
<VideoMontage>
<Duration></Duration>
<Container>
<Format>mp4</Format>
</Container>
<Video>
<Codec>H.264</Codec>
<Bitrate>1000</Bitrate>
<Width>1280</Width>
<Height></Height>
<Fps>30</Fps>
</Video>
<Audio>
<Codec>aac</Codec>
<Samplerate>44100</Samplerate>
<Bitrate>128</Bitrate>
<Channels>4</Channels>
<Remove>false</Remove>
</Audio>
</VideoMontage>
<CreateTime>2020-08-05T11:35:24+0800</CreateTime>
<UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
</TemplateList>
</Response>
Was this page helpful?