DescribeParamTemplates

Last updated: 2025-11-13 20:51:05

DescribeParamTemplates

Last updated: 2025-11-13 20:51:05

1. API Description

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

This API is used to query all parameter template information under the user-specified product.

A maximum of 1000 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: DescribeParamTemplates.
Version	Yes	String	Common Params. The value used for this API: 2019-01-07.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
EngineVersions.N	No	Array of String	Database engine version number
TemplateNames.N	No	Array of String	Template name
TemplateIds.N	No	Array of Integer	Template ID
DbModes.N	No	Array of String	Database Type. Valid values: `NORMAL`, `SERVERLESS`.
Offset	No	Integer	Offset for query
Limit	No	Integer	Limit on queries
Products.N	No	Array of String	Product type of the queried template
TemplateTypes.N	No	Array of String	Template type
EngineTypes.N	No	Array of String	Version type
OrderBy	No	String	The sorting order of the returned results
OrderDirection	No	String	Sorting order. Valid values: `desc`, `asc`.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Number of parameter templates
Items	Array of ParamTemplateListInfo	Parameter template information
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 List of Parameter Panels

List of parameter panels

Input Example

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

{}

Output Example

{
    "Response": {
        "TotalCount": 2,
        "RequestId": "fc791b35-d5e5-4e08-859d-1c095e783199",
        "Items": [
            {
"TemplateDescription": "API testing"
"TemplateName": "APITest"
                "Id": 27,
                "EngineVersion": "5.7",
                "ParamInfoSet": [
                    {
                        "CurrentValue": "12",
API testing
                        "Min": "10",
                        "Default": "10",
                        "Max": "10000",
                        "ParamType": "integer",
                        "EnumValue": [
                            "ON",
                            "OFF"
                        ],
                        "ParamName": "param1",
                        "NeedReboot": 0
                    }
                ],
                "DbMode": "NORMAL"
            },
            {
"TemplateName": "APITest"
"TemplateDescription": "API testing"
                "Id": 28,
                "EngineVersion": "5.7",
                "ParamInfoSet": [
                    {
                        "CurrentValue": "12",
API testing
                        "Min": "10",
                        "Default": "10",
                        "Max": "10000",
                        "ParamType": "integer",
                        "EnumValue": [
                            "21",
                            "22"
                        ],
                        "ParamName": "param2",
                        "NeedReboot": 0
                    }
                ],
                "DbMode": "NORMAL"
            }
        ]
    }
}

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
FailedOperation.OperationFailedError	Operation failed. Try again later. If the problem persists, contact customer service.
UnauthorizedOperation.PermissionDenied	CAM authentication failed.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud