tencent cloud

云点播

文档云点播服务端 API 文档Parameter Template APIsCreateAnimatedGraphicsTemplate

CreateAnimatedGraphicsTemplate

Download
聚焦模式
字号
最后更新时间： 2026-05-19 15:01:21

1. API Description

Domain name for API request: vod.intl.tencentcloudapi.com.

This API is used to create a custom animated image generating template. Up to 16 templates can be created.

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateAnimatedGraphicsTemplate.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required.
Fps Yes Integer Frame rate. Value ranges from 1 to 30. Unit: Hz.
SubAppId No Integer VOD application ID. Customers who activate VOD services after December 25, 2023 must fill this field with the application ID when accessing resources in on-demand applications (whether default or newly created).
Width No Integer Maximum value of the animated gif width (or long edge) in px. Value range: 0 and [128, 4096].
  • If both Width and Height are 0, the resolution is the same as the source.
  • If Width is 0 but Height is not 0, the width will be proportionally scaled.
  • If Width is not 0 but Height is 0, the height will be proportionally scaled.
  • If both Width and Height are not 0, the resolution is as specified by the user.

    • The default value is 0.
    Height No Integer Maximum value of animated gif height (or short edge). Value ranges from 0 to [128, 4096]. Measurement unit: px.
  • If both Width and Height are 0, the resolution is the same as the source.
  • If Width is 0 but Height is not 0, the width will be proportionally scaled.
  • If Width is not 0 but Height is 0, the height will be proportionally scaled.
  • If both Width and Height are not 0, the resolution is as specified by the user.

    • The default value is 0.
    ResolutionAdaptive No String Resolution adaptation, available values:
  • open: start. At this point, Width represents the long side of the video, and Height indicates the short side of the video;
  • close: Close. At this point, Width represents the width of the video, and Height indicates the height of the video.

    • Default value: open.
    Format No String Animated image file format, value is gif and webp. Default is gif.
    Quality No Float Image quality. Valid range: 1 - 100. Default value: 75.
    Name No String Rotating image template name. Length limit: 64 characters.
    Comment No String Template description, with a length limit of 256 characters.

    3. Output Parameters

    Parameter Name Type Description
    Definition Integer Unique identifier of the rotation diagram template.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Creating an animated image generating template

    Input Example

    https://vod.intl.tencentcloudapi.com/?Action=CreateAnimatedGraphicsTemplate
&Name=Animated image generating template 1
&Width=540
&Height=960
&Format=gif
&Fps=30
&<Common request parameters>

    Output Example

    {
    "Response": {
        "Definition": 1008,
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation Operation failed.
    FailedOperation.InvalidVodUser The VOD service is not activated.
    InternalError Internal error.
    InvalidParameterValue.Comment Invalid parameter: template description.
    InvalidParameterValue.Format Incorrect parameter value: Format.
    InvalidParameterValue.FormatWebpLackWidthAndHeight Incorrect parameter value: Format is webp, but both Width and Height are empty.
    InvalidParameterValue.FormatWebpWidthAndHeightBothZero Incorrect parameter value: when Format is webp, Width and Height cannot be both 0.
    InvalidParameterValue.Fps Invalid parameter: video frame rate.
    InvalidParameterValue.Name Incorrect parameter value: Name exceeds the length limit.
    InvalidParameterValue.Quality Incorrect parameter value: Quality.
    InvalidParameterValue.Resolution Invalid parameter: incorrect resolution.
    LimitExceeded.TooMuchTemplate Limit exceeded: The number of templates exceeds the upper limit of 100. If you need more, pleaseSubmit a ticket.
    UnauthorizedOperation Unauthorized operation.
    上一篇: CreateImageSpriteTemplate下一篇: CreateAdaptiveDynamicStreamingTemplate

    帮助和支持

    本页内容是否解决了您的问题？

    填写满意度调查问卷，共创更好文档体验。

    文档反馈