Domain name for API request: vod.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 | The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID. |
Definitions.N | No | Array of Integer | The IDs of the templates to query. Length limit: 100. |
Type | No | String | The template type. Valid values: |
Offset | No | Integer | The offset. Default value: 0. |
Limit | No | Integer | The number of records to return. Default value: 10. Maximum value: 100. |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | The total number of records that meet the conditions. |
ImageProcessingTemplateSet | Array of ImageProcessingTemplate | The information of the queried image processing templates. |
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.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 | Invalid parameter. |
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. |
Was this page helpful?