tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeParamTemplateDetail

最后更新时间：2023-07-06 16:45:55

1. API Description

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

This API is used to query the details of a parameter template.

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.
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, 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

POST / HTTP/1.1Host: cynosdb.tencentcloudapi.comContent-Type: application/jsonX-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": {},
                "NeedReboot": 0,
                "ParamName": "max_user_connections",
                "ParamType": "integer",
                "SupportFunc": false
            }
        ],
        "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

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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款