tencent cloud

APIs

ドキュメントAPIsVideo on DemandParameter Template APIsCreateAnimatedGraphicsTemplate

CreateAnimatedGraphicsTemplate

ダウンロード
フォーカスモード
フォントサイズ
最終更新日: 2026-09-18 15:59:31

1. API Description

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

This API is used to create a custom animated image generating template. Maximum number: 16.

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 range: [1, 30]. Unit: Hz.
SubAppId No Integer VOD application ID. For customers who activate VOD after December 25, 2023, this field must be set to the app ID when accessing resources in VOD applications (whether the default application or a newly created application).
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.

    • Default value: 0.
    Height No Integer Maximum value of the animated gif height (or short side). Value range: 0 and [128, 4096]. 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.

    • Default value: 0.
    ResolutionAdaptive No String Resolution adaptation. Available values:
  • open: enabled. At this point, Width represents the long side of the video, and Height represents the short side of the video;
  • close: closed. 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. Valid values: gif and webp. Default value: gif.
    Quality No Float Image quality. Value 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 for 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 a Rotating Image Template

    Input Example

    https://vod.intl.tencentcloudapi.com/?Action=CreateAnimatedGraphicsTemplate
&Name=Animated Graphics 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 Parameter error: description of this template.
    InvalidParameterValue.Format Parameter value error: Format.
    InvalidParameterValue.FormatWebpLackWidthAndHeight Parameter value error: When Format is webp, Width and Height are empty.
    InvalidParameterValue.FormatWebpWidthAndHeightBothZero Parameter value error: When Format is webp, Width and Height cannot both be 0.
    InvalidParameterValue.Fps Parameter error: video frame rate.
    InvalidParameterValue.Name Parameter value error: Name exceeds the length limit.
    InvalidParameterValue.Quality Parameter value error: Quality.
    InvalidParameterValue.Resolution Parameter error: Resolution error.
    LimitExceeded.TooMuchTemplate Exceed the limit: The number of templates exceeds the upper limit of 100. If needed, submit a ticket (https://console.tencentcloud.com/workorder/category).
    UnauthorizedOperation Unauthorized operation.
    前の記事へ: CreateImageSpriteTemplate次の記事へ: CreateAdaptiveDynamicStreamingTemplate

    ヘルプとサポート

    この記事はお役に立ちましたか？

    フィードバック

    キーワードで検索
      Enter keywords to search documentation