tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeDefaultParams

Last updated: 2024-11-20 11:12:37

    1. API Description

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

    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.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: DescribeDefaultParams.
    Version Yes String Common Params. The value used for this API: 2017-03-20.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    EngineVersion No String Engine version. Currently, the supported versions are 5.1, 5.5, 5.6, 5.7, and 8.0.
    TemplateType No String Type of the default parameter template. Valid values: HIGH_STABILITY (high-stability template), HIGH_PERFORMANCE (high-performance template).
    EngineType No String Parameter template engine. Default value: InnoDB.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of parameters
    Items Array of ParameterDetail Parameter details.
    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 Querying the list of default configurable parameters

    This example shows you how to query the list of default configurable parameters.

    Input Example

    https://cdb.intl.tencentcloudapi.com/?Action=DescribeDefaultParams
&EngineVersion=5.7
&<Common request parameters>

    Output Example

    {
    "Response": {
        "TotalCount": 2,
        "RequestId": "92131c95-aa65-44db-8c3c-e8cd67883b58",
        "Items": [
            {
                "CurrentValue": "utf8",
                "Default": "LATIN1",
                "Description": "Specify default server character set",
                "EnumValue": [
                    "LATIN1",
                    "UTF8",
                    "GBK",
                    "UTF8MB4"
                ],
                "Max": 0,
                "MaxFunc": "",
                "Min": 0,
                "MinFunc": "",
                "Name": "character_set_server",
                "NeedReboot": 1,
                "ParamType": "enum"
            },
            {
                "CurrentValue": "1600",
                "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

    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
    InternalError.UnknownError Unknown error
    InvalidParameter Parameter error.
    InvalidParameterValue.InvalidParameterValueError Invalid parameter value
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy