tencent cloud

Feedback

DescribeDefaultParameters

Last updated: 2023-10-13 09:44:54

    1. API Description

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

    This API is used to query all parameters supported by a database version and engine.

    A maximum of 1000 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: DescribeDefaultParameters.
    Version Yes String Common Params. The value used for this API: 2017-03-12.
    Region No String Common Params. This parameter is not required for this API.
    DBMajorVersion Yes String The major database version number, such as 11, 12, 13.
    DBEngine Yes String Database engine, such as postgresql, mssql_compatible.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of parameters
    ParamInfoSet Array of ParamInfo Parameter information
    Note: This field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the information of all parameters that can be added by a parameter template

    Input Example

    POST / HTTP/1.1
    Host: postgres.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeDefaultParameters
    <Common request parameters>
    
    {
        "DBMajorVersion": "13",
        "DBEngine": "postgresql"
    }
    

    Output Example

    {
        "Response": {
            "TotalCount": 2,
            "RequestId": "xx",
            "ParamInfoSet": [
                {
                    "Advanced": false,
                    "ClassificationCN": "AUTOVACUUM",
                    "ClassificationEN": "Autovacuum",
                    "CurrentValue": "",
                    "DefaultValue": "-1",
                    "EnumValue": null,
                    "ID": 1409,
                    "LastModifyTime": "",
                    "Max": 10000,
                    "Min": -1,
                    "Name": "autovacuum_vacuum_cost_limit",
                    "NeedReboot": false,
                    "ParamDescriptionEN": "Vacuum cost amount available before napping, for autovacuum.",
                    "ParamValueType": "integer",
                    "SpecRelated": false,
                    "StandbyRelated": 0,
                    "Unit": ""
                },
                {
                    "Advanced": false,
                    "ClassificationEN": "Replication",
                    "CurrentValue": "",
                    "DefaultValue": "27",
                    "EnumValue": null,
                    "ID": 1592,
                    "LastModifyTime": "",
                    "Max": 650,
                    "Min": 27,
                    "Name": "max_wal_senders",
                    "NeedReboot": true,
                    "ParamDescriptionEN": "Sets the maximum number of simultaneously running WAL sender processes.",
                    "ParamValueType": "integer",
                    "SpecRelated": true,
                    "StandbyRelated": 1,
                    "Unit": ""
                }
            ]
        }
    }
    

    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.DatabaseAccessError Failed to access database management service. Please try again later. If the problem persists, please contact customer service.
    FailedOperation.FailedOperationError Operation failed. Please try again later.
    InvalidParameter.ParameterCheckError Failed to check the parameter.
    InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support