功能描述
创建智能封面模板。
授权说明
服务开通
使用该功能需提前开通数据万象,并绑定存储桶。详情请参见 绑定存储桶。
使用该功能需提前通过控制台或接口开通媒体处理服务 。详情请参见 开通媒体处理服务。
使用限制
请求
请求示例
POST /template HTTP/1.1Host: <BucketName-APPID>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>Content-Length: <length>Content-Type: application/xml<body>
请求头
请求体
该请求操作的实现需要有如下请求体。
<Request><Tag>SmartCover</Tag><Name>TemplateName</Name><SmartCover><Format>jpg</Format><Width>1280</Width><Height>960</Height><Count>10</Count><DeleteDuplicates>true</DeleteDuplicates></SmartCover></Request>
具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Request | 无 | 保存请求的容器 | Container | 是 |
Container 类型
Request
的具体数据描述如下:节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Tag | Request | 模板类型:SmartCover | String | 是 |
Name | Request | 模板名称,仅支持中文、英文、数字、_、-和*,长度不超过 64 | String | 是 |
SmartCover | Request | 智能封面参数 | Container | 是 |
Container 类型
SmartCover
的具体数据描述如下:节点名称(关键字) | 父节点 | 描述 | 类型 | 默认值 | 是否必选 |
Format | Request.SmartCover | 图片格式,支持 jpg、png 、webp | String | jpg | 否 |
Width | Request.SmartCover | 宽 值范围:[128,4096] 单位:px 若只设置 Width 时,按照视频原始比例计算 Height | String | 视频原始宽度 | 否 |
Height | Request.SmartCover | 高 值范围:[128,4096] 单位:px 若只设置 Height 时,按照视频原始比例计算 Width | String | 视频原始高度 | 否 |
Count | Request.SmartCover | 截图数量,取值范围 [1,10] | String | 3 | 否 |
DeleteDuplicates | Request.SmartCover | 封面去重,取值 true/false | String | false | 否 |
响应
响应头
响应体
该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
<Response><RequestId>NjQ0NGNlNDZfMThhYTk0MGFfY*********</RequestId><Template><Tag>SmartCover</Tag><Name>TemplateName</Name><TemplateId>t1f43110a08702470b8fa75894629501fa</TemplateId><BucketId>test-1234567890</BucketId><Category>Custom</Category><SmartCover><Width>1280</Width><Height>960</Height><Format>jpg</Format><Count>5</Count><DeleteDuplicates>false</DeleteDuplicates></SmartCover><CreateTime>2020-08-05T11:35:24+0800</CreateTime><UpdateTime>2020-08-31T16:15:20+0800</UpdateTime></Template></Response>
具体的数据内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Response | 无 | 保存结果的容器 | Container |
Container 节点
Response
的内容如下:节点名称(关键字) | 父节点 | 描述 | 类型 |
Response | 无 | 保存结果的容器 | Container |
RequestId | 无 | 请求的唯一 ID | Container |
Container 节点
Template
的内容如下节点名称(关键字) | 父节点 | 描述 | 类型 |
Tag | Response.Template | 模板类型,SmartCover | String |
Name | Response.Template | 模板名字 | String |
BucketId | Response.Template | 模板所属存储桶 | String |
Category | Response.Template | 模板属性,Custom 或者 Official | String |
TemplateId | Response.Template | 模板 ID | String |
UpdateTime | Response.Template | 更新时间 | String |
CreateTime | Response.Template | 创建时间 | String |
SmartCover | Response.Template | 详细的模板参数,同请求体 Request.SmartCover 说明 | Container |
错误码
实际案例
请求
POST /template HTTP/1.1Authorization: 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=28e9a4986df11bed0255e97ff90500557e0ea057Host: test-1234567890.ci.ap-beijing.myqcloud.comContent-Length: 1666Content-Type: application/xml<Request><Tag>SmartCover</Tag><Name>TemplateName</Name><SmartCover><Format>jpg</Format><Width>1280</Width><Height>960</Height><Count>10</Count><DeleteDuplicates>true</DeleteDuplicates></SmartCover></Request>
响应
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 100Connection: keep-aliveDate: Thu, 14 Jul 2022 12:37:29 GMTServer: tencent-cix-ci-request-id: NjMxMDJhYTNfMThhYTk0MGFfYmU1OV8zZjc=<Response><RequestId>NjMxMDJhYTNfMThhYTk0MGFfYmU1OV8zZjc=</RequestId><Template><Tag>SmartCover</Tag><Name>TemplateName</Name><TemplateId>t1f16e1dfbdc994105b31292d45710642a</TemplateId><BucketId>test-1234567890</BucketId><Category>Custom</Category><SmartCover><Format>jpg</Format><Width>1280</Width><Height>960</Height><Count>10</Count><DeleteDuplicates>true</DeleteDuplicates></SmartCover><CreateTime>2020-08-05T11:35:24+0800</CreateTime><UpdateTime>2020-08-31T16:15:20+0800</UpdateTime></Template></Response>