功能描述
DescribeMediaTemplates用于搜索视频增强模板。
请求
请求示例
GET /template HTTP/1.1Host: <BucketName-APPID>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>Content-Length: <length>Content-Type: application/xml
说明
请求头
请求体
该请求的请求体为空。
请求参数
参数的具体内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 必选 |
tag | 无 | 模板 Tag:VideoProcess | String | 是 |
category | 无 | Official,Custom,默认值: Custom | String | 是 |
ids | 无 | 模板 ID,以,符号分割字符串 | String | 否 |
name | 无 | 模板名称前缀 | String | 否 |
pageNumber | 无 | 第几页 | Integer | 否 |
pageSize | 无 | 每页个数 | Integer | 否 |
响应
响应头
响应体
该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
<Response><RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhfMjc=</RequestId><TotalCount>1</TotalCount><PageNumber>1</PageNumber><PageSize>10</PageSize><TemplateList><TemplateId>A</TemplateId><Name>TemplateName</Name><Tag>VideoProcess</Tag><VideoProcess><ColorEnhance><Enable>true</Enable><Contrast></Contrast><Correction></Correction><Saturation></Saturation></ColorEnhance><MsSharpen><Enable>true</Enable><SharpenLevel></SharpenLevel></MsSharpen></VideoProcess><CreateTime>2020-08-05T11:35:24+0800</CreateTime><UpdateTime>2020-08-31T16:15:20+0800</UpdateTime></TemplateList></Response>
具体的数据内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Response | 无 | 保存结果的容器 | Container |
Container 节点 Response 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
RequestId | Response | 请求的唯一 ID | String |
TotalCount | Response | 模板总数 | Int |
PageNumber | Response | 当前页数,同请求中的 pageNumber | Int |
PageSize | Response | 每页个数,同请求中的 pageSize | Int |
TemplateList | Response | 模板数组 | Container |
Container节点TemplateList的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
TemplateId | Response.TemplateList | 模板 ID | String |
Name | Response.TemplateList | 模板名字 | String |
BucketId | Response.TemplateList | 模板所属存储桶 | String |
Category | Response.TemplateList | 模板属性,Custom 或者 Official | String |
Tag | Response.TemplateList | 模板类型,VideoProcess | String |
UpdateTime | Response.TemplateList | 更新时间 | String |
CreateTime | Response.TemplateList | 创建时间 | String |
VideoProcess | Response.TemplateList | 详细的模板参数 | Container |
Container节点VideoProcess的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
ColorEnhance | Response.TemplateList.VideoProcess | 同精彩集锦模板 CreateMediaTemplate接口中的 Request.ColorEnhance | Container |
MsSharpen | Response.TemplateList.VideoProcess | 同精彩集锦模板 CreateMediaTemplate 接口中的 Request.MsSharpen | Container |
错误码
实际案例
按照模板ID维度查询
请求
GET /template?ids=A,B,C HTTP/1.1Authorization: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=28e9a4986df11bed0255e97ff90500557e0ea057Host:bucket-1250000000.ci.ap-beijing.myqcloud.comContent-Length: 0Content-Type: application/xml
响应
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 100Connection: keep-aliveDate: Thu, 15 Jun 2017 12:37:29 GMTServer: tencent-cix-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhfMjc=<Response><RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhfMjc=</RequestId><TemplateList><TemplateId>A</TemplateId><Name>TemplateName</Name><Tag>VideoProcess</Tag><VideoProcess><ColorEnhance><Enable>true</Enable><Contrast></Contrast><Correction></Correction><Saturation></Saturation></ColorEnhance><MsSharpen><Enable>true</Enable><SharpenLevel></SharpenLevel></MsSharpen></VideoProcess><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.1Authorization: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=28e9a4986df11bed0255e97ff90500557e0ea057Host:bucket-1250000000.ci.ap-beijing.myqcloud.comContent-Length: 0Content-Type: application/xml
响应
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 100Connection: keep-aliveDate: Thu, 15 Jun 2017 12:37:29 GMTServer: tencent-cix-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhfMjc=<Response><RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhfMjc=</RequestId><TotalCount>1</TotalCount><PageNumber>1</PageNumber><PageSize>10</PageSize><TemplateList><TemplateId>A</TemplateId><Name>TemplateName</Name><Tag>VideoProcess</Tag><VideoProcess><ColorEnhance><Enable>true</Enable><Contrast></Contrast><Correction></Correction><Saturation></Saturation></ColorEnhance><MsSharpen><Enable>true</Enable><SharpenLevel></SharpenLevel></MsSharpen></VideoProcess><CreateTime>2020-08-05T11:35:24+0800</CreateTime><UpdateTime>2020-08-31T16:15:20+0800</UpdateTime></TemplateList></Response>