DescribeProcessImageTemplates

Last updated: 2025-12-02 14:27:09Download PDF

1. API Description

Domain name for API request: mps.intl.tencentcloudapi.com.

This API is used to query the list of image processing templates.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: DescribeProcessImageTemplates.
Version	Yes	String	Common Params. The value used for this API: 2019-06-12.
Region	No	String	Common Params. This parameter is not required for this API.
Definitions.N	No	Array of Integer	Filtering condition for the unique identifier of the image processing template. The array length cannot exceed 100.
Offset	No	Integer	Pagination offset. The default value is 0.
Limit	No	Integer	Number of returned entries. The default value is 10, and the maximum value is 100.
Name	No	String	Filtering condition for the identifier of the image processing template.
OrderType	No	Integer	Sorting method. It is valid after OrderBy is set. Valid values: 0: ascending; 1: descending. The default value is 0.
OrderBy	No	String	Sorting field. Valid values: Definition: unique identifier of the template. Default value: creation time.
Type	No	String	Filtering condition for the template type. Valid values: Preset: system preset template; Custom: user-defined template.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of records that meet the filtering conditions.
ProcessImageTemplateSet	Array of ProcessImageTemplate	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.

4. Example

Example1 Querying All Image Processing Templates

This example shows you how to query information about all image processing templates, including system preset templates and custom templates.

Input Example

POST / HTTP/1.1
Host: mps.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProcessImageTemplates
<Common request parameters>

{}

Output Example

{
    "Response": {
        "ProcessImageTemplateSet": [
            {
                "Comment": "",
                "CreateTime": "2025-11-11T02:40:24Z",
                "Definition": 20180,
                "Name": "",
                "ProcessImageConfig": {
                    "EncodeConfig": {
                        "Format": "JPEG",
                        "Quality": 80
                    },
                    "EnhanceConfig": {
                        "ImageQualityEnhance": {
                            "Switch": "ON",
                            "Type": "weak"
                        }
                    }
                },
                "Type": "Custom",
                "UpdateTime": "2025-11-11T02:40:24Z"
            }
        ],
        "RequestId": "6781d678-c8d0-4af3-87c1-f31050c8a76a",
        "TotalCount": 1
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InternalError	Internal error.
InvalidParameterValue	Incorrect parameter value.
InvalidParameterValue.Definitions	Parameter error: Definitions.
InvalidParameterValue.Limit	Parameter error: Limit.
ResourceNotFound.TemplateNotExist	The resource does not exist: the template does not exist.