tencent cloud



Last updated: 2022-08-17 15:58:08

1. API Description

Domain name for API request: cdb.tencentcloudapi.com.

This API is used to query parameter template details. The common request parameter Region can only be set to ap-guangzhou.

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: DescribeParamTemplateInfo.
Version Yes String Common Params. The value used for this API: 2017-03-20.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou.
TemplateId Yes Integer Parameter template ID.

3. Output Parameters

Parameter Name Type Description
TemplateId Integer Parameter template ID.
Name String Parameter template name.
EngineVersion String Database engine version specified in the parameter template
TotalCount Integer Number of parameters in the parameter template
Items Array of ParameterDetail Parameter details
Description String Parameter template description
TemplateType String Type of the parameter template. Valid values: HIGH_STABILITY (high-stability template), HIGH_PERFORMANCE (high-performance template).
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the parameter template details

Input Example

&<Common request parameters>

Output Example

    "Response": {
        "TemplateId": 233,
        "Name": "test",
        "EngineVersion": "5.7",
        "Description": "test",
        "TotalCount": 72,
        "TemplateType": "HIGH_STABILITY",
        "RequestId": "92131c95-aa65-44db-8c3c-e8cd67883b58",
        "Items": [
                "CurrentValue": "1",
                "Default": "1",
                "Description": "Controls the interval between successive column values.",
                "EnumValue": [],
                "Max": 65535,
                "MaxFunc": "",
                "Min": 1,
                "MinFunc": "",
                "Name": "auto_increment_increment",
                "NeedReboot": 0,
                "ParamType": "integer"
                "CurrentValue": "1",
                "Default": "1",
                "Description": "Determines the starting point for the AUTO_INCREMENT column value.",
                "EnumValue": [],
                "Max": 65535,
                "MaxFunc": "",
                "Min": 1,
                "MinFunc": "",
                "Name": "auto_increment_offset",
                "NeedReboot": 0,
                "ParamType": "integer"
                "CurrentValue": "800",
                "Default": "{MIN(DBInitMemory/4+500,1000000)}",
                "Description": "The maximum permitted number of simultaneous client connections.",
                "EnumValue": [],
                "Max": 100000,
                "MaxFunc": "100000",
                "Min": 1,
                "MinFunc": "1",
                "Name": "max_connections",
                "NeedReboot": 0,
                "ParamType": "func"

5. Developer Resources


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

Command Line Interface

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
AuthFailure CAM signature/authentication error.
CdbError Backend or process error.
InternalError.DatabaseAccessError Internal database error.
InternalError.ParamError Parameter error
InvalidParameter Parameter error.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support