tencent cloud

APIs

文档APIsVideo on DemandParameter Template APIsModifyAnimatedGraphicsTemplate

ModifyAnimatedGraphicsTemplate

下载
聚焦模式
字号
最后更新时间： 2026-09-18 15:59:14

1. API Description

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

Modify a custom animated image generating template.

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: ModifyAnimatedGraphicsTemplate.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required.
Definition Yes Integer Unique identifier for rotation diagram template.
SubAppId No Integer VOD application ID. For customers who activate VOD services after December 25, 2023, this field must be set to the app ID when accessing resources in VOD applications, whether in the default application or a newly created application.
Name No String Rotating image template name. Length limit: 64 characters.
Width No Integer The maximum value of the animated gif width (or long side). Valid values: 0 and [32, 4096]. Unit: px.
  • When Width and Height are both 0, the resolution is from the same source;
  • When Width is 0 and Height is non-0, Width is scaled proportionally;
  • When Width is non-0 and Height is 0, the Height is scaled proportionally;
  • When both Width and Height are non-0, the resolution is specified by the user.
    • Default value: 0.
    Height No Integer The maximum value of the animated gif height (or short side). Valid values: 0 and [32, 4096]. Unit: px.
  • When Width and Height are both 0, the resolution is from the same source;
  • When Width is 0 and Height is non-0, Width is scaled proportionally;
  • When Width is non-0 and Height is 0, the Height is scaled proportionally;
  • When both Width and Height are non-0, the resolution is specified by the user.
    • Default value: 0.
    ResolutionAdaptive No String Resolution adaptation. Available values:
  • open: enable. At this point, Width represents the long side of the video, and Height indicates the short side of the video;
  • close: closed. At this point, Width represents the video width, and Height indicates the video height.

    • Default value: open.
    Format No String Animated image file format. Valid values: gif and webp.
    Fps No Integer Frame rate. Value range: [1, 30]. Unit: Hz.
    Quality No Float Image quality. Valid range: [1, 100]. Default value: 75.
    Comment No String Template description, with a length limit of 256 characters.

    3. Output Parameters

    Parameter Name Type Description
    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 Modifying a Rotating Image Template

    Input Example

    https://vod.intl.tencentcloudapi.com/?Action=ModifyAnimatedGraphicsTemplate
&Definition=10001
&Name=Rotating image template 1
&Width=540
&Height=960
&Fps=30
&<Common request parameters>

    Output Example

    {
    "Response": {
        "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.
    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.
    ResourceNotFound.TemplateNotExist Resource does not exist: template does not exist.
    UnauthorizedOperation Unauthorized operation.
    上一篇: ModifyImageSpriteTemplate下一篇: ModifyAdaptiveDynamicStreamingTemplate

    帮助和支持

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

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

    文档反馈

    搜索
      请输入关键词搜索文档