Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to create a custom image processing template. A template can include at most 10 operations, for example, crop-scale-crop-blur-scale-crop-scale-crop-blur-scale. You can have up to 16 image processing templates.
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: CreateImageProcessingTemplate. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| Operations.N | Yes | Array of ImageOperation | Image processing operation array. Operations are performed in the order they appear in the array. |
| 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). |
| Name | No | String | Image processing template name. The length cannot exceed 64 characters. |
| Comment | No | String | Template description, with a length limit of 256 characters. |
| Parameter Name | Type | Description |
|---|---|---|
| Definition | Integer | Unique identifier of the image processing template. |
| 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. |
Create an image processing template with short edge scaling.
https://vod.intl.tencentcloudapi.com/?Action=CreateImageProcessingTemplate
&Operations.0.Type=Scale
&Operations.0.Scale.Type=ShortEdgeFirst
&Operations.0.Scale.ShortEdge=120
&<Common request parameters>
{
"Response": {
"Definition": 1008,
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}
Create an Image Processing Template for 240x240 thumbnails.
https://vod.intl.tencentcloudapi.com/?Action=CreateImageProcessingTemplate
&Operations.0.Type=Scale
&Operations.0.Scale.Type=ShortEdgeFirst
&Operations.0.Scale.ShortEdge=240
&Operations.1.Type=CenterCut
&Operations.1.CenterCut.Type=Rectangle
&Operations.1.CenterCut.Width=240
&Operations.1.CenterCut.Height=240
&<Common request parameters>
{
"Response": {
"Definition": 1009,
"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.Comment | Invalid parameter: template description. |
| InvalidParameterValue.CutAndCrops | Parameter error: Invalid CutAndCrops value. |
| InvalidParameterValue.Name | Incorrect parameter value: Name exceeds the length limit. |
| InvalidParameterValue.Thumbnails | Parameter error: Invalid Thumbnail value. |
| InvalidParameterValue.Watermarks | Parameter error: Invalid Watermarks value. |
| LimitExceeded.TooMuchTemplate | Limit exceeded: The number of templates exceeds the upper limit of 100. If you need more, pleaseSubmit a ticket. |
| UnauthorizedOperation | Unauthorized operation. |
文档反馈