有奖捉虫:云通信与企业服务文档专题,速来> HOT

功能描述

创建智能封面模板。


请求

请求示例

POST /template HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Content-Type: application/xml

<body>
说明
Authorization: Auth String(详情请参见 请求签名 文档)。
通过子账号使用时,需要授予相关的权限,详情请参见 授权粒度详情 文档。

请求头

此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。

请求体

该请求操作的实现需要有如下请求体。
<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
模板名称仅支持中文、英文、数字、_、-和*
String
SmartCover
Request
智能封面参数
Container
Container 类型 SmartCover 的具体数据描述如下:

节点名称(关键字)
父节点
描述
类型
是否必选
默认值
限制
Format
Request.SmartCover
图片格式
String
jpg
jpg、png 、webp
Width
Request.SmartCover
String
视频原始宽度
值范围:[128,4096]
单位:px
若只设置 Width 时,按照视频原始比例计算 Height
Height
Request.SmartCover
String
视频原始高度
值范围:[128,4096]
单位:px
若只设置 Height 时,按照视频原始比例计算 Width
Count
Request.SmartCover
截图数量
String
3
[1,10]
DeleteDuplicates
Request.SmartCover
封面去重
String
false
true/false

响应

响应头

此接口仅返回公共响应头部,详情请参见 公共响应头部 文档。

响应体

该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
<Response>
<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 的内容:

节点名称(关键字)
父节点
描述
类型
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
详细的模板参数,同上述请求体部分 SmartCover 说明
Container

错误码

该请求操作无特殊错误信息,常见的错误信息请参见 错误码 文档。

实际案例

请求

POST /template 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=28e9a4986df11bed0255e97ff90500557e0ea057
Host: test-1234567890.ci.ap-beijing.myqcloud.com
Content-Length: 1666
Content-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 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: NTk0MjdmODlfMjQ4OGY3XzYzYzh****=

<Response>
<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>