DescribeParamTemplateInfo

最后更新时间：2024-01-30 10:25:44

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	No	String	Common Params. This parameter is not required for this API.
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).
EngineType	String	Parameter template engine. Valid values: `InnoDB`, `RocksDB`. Note: This field may return null, indicating that no valid values can be obtained.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the details of a parameter template

This example shows you how to query the details of a parameter template.

Input Example

https://cdb.tencentcloudapi.com/?Action=DescribeParamTemplateInfo&TemplateId=233&<common request parameters>

Output Example

   "Response": {        "TemplateId": 233,        "Name": "st",        "EngineVersion": "5.7",        "Description": "test",        "TotalCount": 72,        "TemplateType": "HIGH_STABILITY",        "RequestId": "92131c95-aa65-44db-8c3c-e8cd67883b58",        "EngineType": "InnoDB",        "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

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

tencent cloud

Recent Pages