DescribeAnimatedGraphicsTemplates
Last updated: 2023-10-12 16:47:40Download PDF
1. API Description
Domain name for API request: mps.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: 2019-06-12. |
Region | No | String | Common Params. This parameter is not required for this API. |
Definitions.N | No | Array of Integer | Unique ID filter of animated image generating templates. Array length limit: 100. |
Offset | No | Integer | Paging 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: |
3. Output Parameters
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. |
4. Example
Example1 Querying animated image generating templates
Input Example
https://mps.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,
"ResolutionAdaptive": "open",
"Type": "Preset",
"Quality": 0.0,
"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.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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.InvalidMpsUser | Operation failed: unauthorized MPS user. |
InternalError | Internal error. |
InvalidParameterValue.Limit | Parameter error: Limit. |
InvalidParameterValue.Type | Parameter error: incorrect Type value. |