Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to query image processing templates. You can specify the filters as well as the offset to start returning records from.
A maximum of 20 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: DescribeImageProcessingTemplates. |
| 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 | Image processing template flag list. Length limit: 100. |
| Type | No | String | Condition for filtering templates by type. Valid values: |
| Offset | No | Integer | Pagination offset. Default value: 0. |
| Limit | No | Integer | Number of returned entries. Default value: 10. Maximum value: 100. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of records that meet the filtering conditions. |
| ImageProcessingTemplateSet | Array of ImageProcessingTemplate | List of image processing template details. |
| 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. |
This example shows you how to query image processing templates.
https://vod.intl.tencentcloudapi.com/?Action=DescribeImageProcessingTemplates
&Definitions.0=1008
&Definitions.1=1009
&<Common request parameters>
{
"Response": {
"TotalCount": 2,
"ImageProcessingTemplateSet": [
{
"Definition": 1008,
"Comment": "",
"Name": "",
"Type": "Custom",
"CreateTime": "2018-10-01T10:00:00Z",
"Operations": [
{
"Type": "CenterCut",
"CenterCut": {
"Type": "Circle",
"Radius": 30
}
},
{
"Type": "Scale",
"Scale": {
"Type": "ShortEdgeFirst",
"ShortEdge": 100
}
}
]
},
{
"Definition": 1009,
"Comment": "",
"Name": "",
"Type": "Custom",
"CreateTime": "2018-10-01T10:00:00Z",
"Operations": [
{
"Type": "Scale",
"Scale": {
"Type": "WidthFirst",
"Width": 200
}
}
]
}
],
"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. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue.Definitions | Invalid parameter: Definitions. |
| InvalidParameterValue.Limit | Invalid parameter: Limit. |
| ResourceNotFound.TemplateNotExist | The resource does not exist: the template does not exist. |
| UnauthorizedOperation | Unauthorized operation. |
文档反馈