Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to obtain the template details list of image asynchronous processing based on the Template Unique Identifier. The returned results include ALL eligible user-customized image asynchronous 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: DescribeProcessImageAsyncTemplates. |
| 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 | Filtering condition for the unique identifier of the image async processing template. The maximum array length is 100. |
| 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. |
| ProcessImageAsyncTemplateSet | Array of ProcessImageAsyncTemplateItem | List of image asynchronous 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. |
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProcessImageAsyncTemplates
<Common request parameters>
{
"SubAppId": 221073,
"Definitions": [
7
]
}
{
"Response": {
"ProcessImageAsyncTemplateSet": [
{
"Comment": "testcomment",
"CreateTime": "2026-01-20T03:02:33Z",
"Definition": 7,
"Name": "test3",
"ProcessImageConfigure": {
"EncodeConfig": {
"Format": "PNG",
"Quality": 100
},
"EnhanceConfig": {
"AdvancedSuperResolution": {
"Height": 720,
"Mode": "percent",
"Percent": 2,
"Switch": "ON",
"Type": "standard",
"Width": 1280
},
"ColorEnhance": {
"Switch": "ON",
"Type": "weak"
},
"Denoise": {
"Switch": "ON",
"Type": "weak"
},
"FaceEnhance": {
"Intensity": 1,
"Switch": "ON"
},
"ImageQualityEnhance": {
"Switch": "ON",
"Type": "weak"
},
"LowLightEnhance": {
"Switch": "ON",
"Type": "normal"
},
"SharpEnhance": {
"Intensity": 1,
"Switch": "ON"
},
"SuperResolution": null
}
},
"Type": "Custom",
"UpdateTime": "2026-01-26T09:21:49Z"
}
],
"TotalCount": 1,
"RequestId": "08cfed0c-2b5a-41bf-b0dd-b1985db203d8"
}
}
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. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| LimitExceeded.TooMuchTemplate | Limit exceeded: The number of templates exceeds the upper limit of 100. If you need more, pleaseSubmit a ticket. |
| ResourceNotFound | The resource does not exist. |
| ResourceNotFound.TemplateNotExist | The resource does not exist: the template does not exist. |
| UnauthorizedOperation | Unauthorized operation. |
피드백