Last updated: 2022-01-19 11:36:22

1. API Description

Domain name for API request:

This API (DescribeDefaultParams) is used to query the list of default configurable parameters.

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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeDefaultParams.
Version Yes String Common parameter. The value used for this API: 2017-03-20.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
EngineVersion Yes String MySQL version. Currently, the supported versions are ["5.1", "5.5", "5.6", "5.7"].

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of parameters
Items Array of ParameterDetail Parameter details.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the list of default configurable parameters

Input Example
&<Common request parameters>

Output Example

  "Response": {
    "TotalCount": 2,
    "RequestId": "92131c95-aa65-44db-8c3c-e8cd67883b58",
    "Items": [
        "CurrentValue": "800",
        "Name": "max_connections",
        "Min": 1,
        "Default": "151",
        "Max": 10240,
        "ParamType": "integer",
        "EnumValue": [],
        "NeedReboot": 0,
        "Description": "The maximum permitted number of simultaneous client connections."
        "CurrentValue": "utf8",
        "Name": "character_set_server",
        "Min": 0,
        "Default": "utf8",
        "Max": 0,
        "ParamType": "enum",
        "EnumValue": [
        "NeedReboot": 1,
        "Description": "Specify default server character set."

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.