Domain name for API request: vod.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 | An array of image processing operations. The operations will be performed in the specified order. |
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. |
Name | No | String | The name of the image processing template. Length limit: 64 characters. |
Comment | No | String | The template description. Length limit: 256 characters. |
Parameter Name | Type | Description |
---|---|---|
Definition | Integer | The template ID. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to create an image processing template that generates 240 x 240 thumbnails.
https://vod.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"
}
}
This example shows you how to create an image processing template that scales an image according to the specified short side.
https://vod.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"
}
}
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.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. |
Was this page helpful?