DescribeParamTemplateDetail

Download PDF

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

DescribeParamTemplateDetail

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

Download PDF

1. API Description

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

This API is used to query user parameter template details.

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: DescribeParamTemplateDetail.
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.
TemplateId	Yes	Integer	Parameter template ID

3. Output Parameters

Parameter Name	Type	Description
TemplateId	Integer	Parameter template ID
TemplateName	String	Parameter template name
TemplateDescription	String	Parameter template description
EngineVersion	String	Engine version
TotalCount	Integer	Total number of parameters
Items	Array of ParamDetail	List of parameters
DbMode	String	Database type. Valid values: `NORMAL`, `SERVERLESS`.
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 This API is used to query parameter template details.

This API is used to query parameter template details.

Input Example

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

{
    "TemplateId": 4837003
}

Output Example

{
    "Response": {
        "DbMode": "NORMAL",
        "EngineVersion": "5.7",
        "Items": [
            {
                "CurrentValue": "1000",
                "Default": "0",
                "Description": "The maximum permitted number of simultaneous client connections per user.",
                "EnumValue": [],
                "Func": "",
                "IsFunc": false,
                "IsGlobal": 0,
                "MatchType": "",
                "MatchValue": "",
                "Max": "10240",
                "Min": "0",
                "ModifiableInfo": {
                    "IsModifiable": 1
                },
                "NeedReboot": 0,
                "ParamName": "max_user_connections",
                "ParamType": "integer",
                "SupportFunc": false,
                "FuncPattern": "{MAX(DBInitCpu/%d,%d)},2,4"
            }
        ],
        "RequestId": "ca8481bf-ba79-42ba-b90b-bd47df104add",
"TemplateDescription": "test template"
        "TemplateId": 4837003,
"TemplateName": "Test Template"
        "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
FailedOperation.OperationFailedError	Operation failed. Try again later. If the problem persists, contact customer service.
OperationDenied.CamDeniedError	Failed to verify permissions
UnauthorizedOperation.PermissionDenied	CAM authentication failed.

Was this page helpful?

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

Yes

Feedback

tencent cloud