tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeDBInstanceParameters

Last updated: 2024-06-17 14:26:08

    1. API Description

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

    This API is used to query the parameters of an instance.

    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: DescribeDBInstanceParameters.
    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.
    DBInstanceId Yes String Instance ID
    ParamName No String Name of the parameter to be queried. If ParamName is left empty or not passed in, the list of all parameters will be returned.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of the parameters in the returned list
    Detail Array of ParamInfo Details of the returned parameter list
    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 information of parameter specified by the instance

    This example shows you how to query the parameter information of the parameters postgres-lzrwgg6d and max_connecions.

    Input Example

    POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBInstanceParameters
<Common request parameters>

{
    "ParamName": "max_connections",
    "DBInstanceId": "postgres-lzrwgg6d"
}

    Output Example

    {
    "Response": {
        "Detail": [
            {
                "Advanced": false,
                "ClassificationCN": "u200c连接和认证",
                "ClassificationEN": "Connections and Authentication",
                "CurrentValue": "2048",
                "DefaultValue": "2048",
                "EnumValue": null,
                "ID": 15124,
                "LastModifyTime": "",
                "Max": 2048,
                "Min": 100,
                "Name": "max_connections",
                "NeedReboot": true,
                "ParamDescriptionCH": "Maximum instance connections",
                "ParamDescriptionEN": "Sets the maximum number of concurrent connections.",
                "ParamValueType": "integer",
                "SpecRelated": true,
                "SpecRelationSet": null,
                "StandbyRelated": 0,
                "Unit": "",
                "VersionRelationSet": null
            }
        ],
        "RequestId": "ce4ecf74-b26f-44e7-9340-539032e92b9f",
        "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.CamAuthFailed CAM authentication failed.
    FailedOperation.FailedOperationError Operation failed. Please try again later.
    InternalError.InternalHttpServerError An exception occurred while executing the request.
    InternalError.UnknownError Unknown error. When this error occurs, please contact customer service for assistance.
    InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
    OperationDenied.CamDeniedError This operation cannot be performed.
    OperationDenied.InstanceAccessDeniedError You do not have the permission to operate this resource.
    ResourceNotFound.InstanceNotFoundError The instance does not exist.
    UnknownError Unknown error. When this error occurs, please contact customer service for assistance.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy