云点播创建转动图模板-参数模板相关接口-API 中心-腾讯云

1. 接口描述

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

创建用户自定义转动图模板，数量上限：16。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateAnimatedGraphicsTemplate。
Version	是	String	公共参数，本接口取值：2018-07-17。
Region	否	String	公共参数，此参数为可选参数。
Fps	是	Integer	帧率，取值范围：[1, 30]，单位：Hz。示例值：30
SubAppId	否	Integer	点播应用 ID。从2023年12月25日起开通点播的客户，如访问点播应用中的资源（无论是默认应用还是新创建的应用），必须将该字段填写为应用 ID。示例值：1490012345
Width	否	Integer	动图宽度（或长边）的最大值，取值范围：0 和 [128, 4096]，单位：px。当 Width、Height 均为 0，则分辨率同源；当 Width 为 0，Height 非 0，则 Width 按比例缩放；当 Width 非 0，Height 为 0，则 Height 按比例缩放；当 Width、Height 均非 0，则分辨率按用户指定。默认值：0。示例值：540
Height	否	Integer	动图高度（或短边）的最大值，取值范围：0 和 [128, 4096]，单位：px。当 Width、Height 均为 0，则分辨率同源；当 Width 为 0，Height 非 0，则 Width 按比例缩放；当 Width 非 0，Height 为 0，则 Height 按比例缩放；当 Width、Height 均非 0，则分辨率按用户指定。默认值：0。示例值：960
ResolutionAdaptive	否	String	分辨率自适应，可选值： open：开启，此时，Width 代表视频的长边，Height 表示视频的短边； close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。默认值：open。示例值：open
Format	否	String	动图格式，取值为 gif 和 webp。默认为 gif。示例值：gif
Quality	否	Float	图片质量，取值范围：[1, 100]，默认值为 75。示例值：80
Name	否	String	转动图模板名称，长度限制：64 个字符。示例值：TestTemplate
Comment	否	String	模板描述信息，长度限制：256 个字符。示例值：test template

3. 输出参数

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

4. 示例

示例1 创建转动图模板

输入示例

https://vod.tencentcloudapi.com/?Action=CreateAnimatedGraphicsTemplate
&Name=动图图模板1
&Width=540
&Height=960
&Format=gif
&Fps=30
&<公共请求参数>

输出示例

{
    "Response": {
        "Definition": 1008,
        "RequestId": "12ae8d8e-dce3-4151-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. 错误码

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

错误码	描述
FailedOperation	操作失败。
FailedOperation.InvalidVodUser	没有开通点播业务。
InternalError	内部错误。
InvalidParameterValue.Comment	参数错误：对该模板的描述。
InvalidParameterValue.Format	参数值错误：Format。
InvalidParameterValue.FormatWebpLackWidthAndHeight	参数值错误：Format 为 webp 时，Width、Height 均为空。
InvalidParameterValue.FormatWebpWidthAndHeightBothZero	参数值错误：Format 为 webp 时，不允许 Width、Height 都为 0。
InvalidParameterValue.Fps	参数错误：视频帧率。
InvalidParameterValue.Name	参数值错误：Name 超过长度限制。
InvalidParameterValue.Quality	参数值错误：Quality。
InvalidParameterValue.Resolution	参数错误：分辨率错误。
LimitExceeded.TooMuchTemplate	超过限制值：模板数超过上限 100 个，如需更多请提交工单。
UnauthorizedOperation	未授权操作。

创建转动图模板

本页目录：