tencent cloud

云点播

DescribeAnimatedGraphicsTemplates

Download
聚焦模式
字号
最后更新时间: 2026-05-19 15:00:56

1. API Description

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

This API is used to query the list of animated image generating templates and supports paged queries by filters.

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: DescribeAnimatedGraphicsTemplates.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required.
SubAppId No Integer On-demand application ID. Customers who activate on-demand services from December 25, 2023 must fill this field with the app ID when accessing resources in on-demand applications (whether default or newly created).
Definitions.N No Array of Integer Filtering condition for the unique identifier of the rotation diagram template. The array length cannot exceed 100.
Offset No Integer Pagination offset. Default value: 0.
Limit No Integer Number of returned entries. Default value: 10. Maximum value: 100.
Type No String Condition for filtering templates by type. Valid values:
  • Preset: system preset template;
  • Custom: User-defined template.
  • 3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of records that meet the filtering conditions.
    AnimatedGraphicsTemplateSet Array of AnimatedGraphicsTemplate Rotation diagram template details list.
    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 Querying animated image generating templates

    Input Example

    https://vod.intl.tencentcloudapi.com/?Action=DescribeAnimatedGraphicsTemplates
    &Definitions.0=10001
    &<Common request parameters>
    

    Output Example

    {
        "Response": {
            "TotalCount": 1,
            "AnimatedGraphicsTemplateSet": [
                {
                    "Definition": 10001,
                    "Name": "Animated image generating template 1",
                    "CreateTime": "2018-10-01T10:00:00Z",
                    "UpdateTime": "2018-10-01T10:00:00Z",
                    "Height": 540,
                    "Width": 960,
                    "Format": "gif",
                    "Fps": 30,
                    "Quality": 75,
                    "ResolutionAdaptive": "open",
                    "Type": "Custom",
                    "Comment": ""
                }
            ],
            "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.Definitions Invalid parameter: Definitions.
    InvalidParameterValue.Limit Invalid parameter: Limit.
    InvalidParameterValue.Type Incorrect Type parameter value.
    UnauthorizedOperation Unauthorized operation.

    帮助和支持

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

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

    文档反馈