Domain name for API request: vod.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.
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 | The VOD subapplication ID. If you need to access a resource in a subapplication, set this parameter to the subapplication ID; otherwise, leave it empty. |
Definitions.N | No | Array of Integer | Unique ID filter of animated image generating templates. Array length limit: 100. |
Offset | No | Integer | Paged offset. Default value: 0. |
Limit | No | Integer | Number of returned entries. Default value: 10. Maximum value: 100. |
Type | No | String | Template type filter. Valid values: |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Number of eligible entries. |
AnimatedGraphicsTemplateSet | Array of AnimatedGraphicsTemplate | List of animated image generating template details. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://vod.tencentcloudapi.com/?Action=DescribeAnimatedGraphicsTemplates
&Definitions.0=10001
&<Common request parameters>
{
"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"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
Was this page helpful?