DescribeDBParameters

Last updated:2026-03-13 18:56:41

DescribeDBParameters

Last updated: 2026-03-13 18:56:41

1. API Description

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

This API is used to obtain the current parameter settings of the instance.

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: DescribeDBParameters.
Version	Yes	String	Common Params. The value used for this API: 2021-11-22.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Instance ID, for example: tdsql3-ow728lmc.

3. Output Parameters

Parameter Name	Type	Description
InstanceId	String	Instance ID, for example: tdsql3-ow728lmc.
Params	Array of ParamDesc	Request the current parameter value of the instance.
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 Obtaining the Current Parameters of a Database

Input Example

https://tdmysql.intl.tencentcloudapi.com/?Action=DescribeDBParameters
&InstanceId=tdsql3-ige1a5k3
&<Common request parameters>

Output Example

{
    "Response": {
        "InstanceId": "tdsql3-ige1a5k3",
        "Params": [
            {
                "Default": "1",
                "SetValue": "",
                "Value": "1",
                "Param": "auto_increment_increment",
                "Constraint": {
                    "Range": {
                        "Max": "65535",
                        "Min": "1"
                    },
                    "Type": "section"
                },
                "HaveSetValue": false,
                "NeedRestart": true,
                "Description": ""
            },
            {
                "Default": "ON",
                "SetValue": "",
                "Description": "",
                "Value": "ON",
                "Param": "autocommit",
                "Constraint": {
                    "Enum": "ON,OFF",
                    "Type": "enum"
                },
                "HaveSetValue": false,
                "NeedRestart": true
            }
        ],
        "RequestId": "914db412-d6e6-47ad-8e62-d06e02e52a56"
    }
}

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.CamAuthError	CAM authentication error.
AuthFailure.CheckCamAuthError	CAM authentication request parameter check failed.
AuthFailure.UnauthorizedOperation	CAM authentication failure.
FailedOperation.DBQueryInstanceError	Query instance data failed.
FailedOperation.OssGetVariablesError	Oss query parameter error.
InvalidParameterValue.CheckInstanceVersionError	Instance version validation error.

Was this page helpful?

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

Yes

Feedback

tencent cloud