云点播创建片头片尾模板-参数模板相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： vod.tencentcloudapi.com 。

创建片头片尾模板。

最大支持模板数量为 100 个。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateHeadTailTemplate。
Version	是	String	公共参数，本接口取值：2018-07-17。
Region	否	String	公共参数，此参数为可选参数。
Name	是	String	模板名，长度限制 64 个字符。示例值：模板名1
SubAppId	否	Integer	点播应用 ID。从2023年12月25日起开通点播的客户，如访问点播应用中的资源（无论是默认应用还是新创建的应用），必须将该字段填写为应用 ID。示例值：125000
Comment	否	String	模板描述信息，长度限制 256 个字符。示例值：描述信息
HeadCandidateSet.N	否	Array of String	片头候选列表，填写视频的 FileId。转码时将自动选择与正片宽高比最接近的一个片头（相同宽高比时，靠前的候选项优先）。最多支持 5 个候选片头。示例值：["333XXX123"]
TailCandidateSet.N	否	Array of String	片尾候选列表，填写视频的 FileId。转码时将自动选择与正片宽高比最接近的一个片尾（相同宽高比时，靠前的候选项优先）。最多支持 5 个候选片尾。示例值：["1233XXX3122"]
FillType	否	String	填充方式，当视频流配置宽高参数与原始视频的宽高比不一致时，对转码的处理方式，即为“填充”。可选填充方式： stretch：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁“或者“拉长“； gauss：高斯模糊，保持视频宽高比不变，边缘剩余部分使用高斯模糊； white：留白，保持视频宽高比不变，边缘剩余部分使用白色填充； black：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。默认值：stretch 。示例值：black

3. 输出参数

参数名称	类型	描述
Definition	Integer	片头片尾模板号。示例值：10000
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建片头片尾模板

创建片头片尾模板。

输入示例

https://vod.tencentcloudapi.com/?Action=CreateHeadTailTemplate
&Name=模板名
&Comment=模板描述
&HeadCandidateSet.0=1234422xxxx123
&TailCandidateSet.0=1234422xxxx124
&<公共请求参数>

输出示例

{
    "Response": {
        "Definition": 1000,
        "RequestId": "12ae8d8e-xxxx-9d4b-5594145287e1"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
FailedOperation.InvalidVodUser	没有开通点播业务。
InternalError	内部错误。
InternalError.GenDefinition	内部错误：生成模板 ID 失败。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.Comment	参数错误：对该模板的描述。
InvalidParameterValue.Name	参数值错误：Name 超过长度限制。
InvalidParameterValue.Type	Type 参数值错误。
LimitExceeded.TooMuchTemplate	超过限制值：模板数超过上限 100 个，如需更多请提交工单。
UnauthorizedOperation	未授权操作。

创建片头片尾模板

本页目录：