tencent cloud

Feedback

DescribeDBInstanceParameters

Last updated: 2022-07-08 10:18:49

1. API Description

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

This API is used to get the list of modifiable parameters of an 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: DescribeDBInstanceParameters.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
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, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the list of modifiable parameters of instance

This example shows you how to get the list of modifiable parameters of an instance.

Input Example

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

{
    "DBInstanceId": "xx",
    "ParamName": "default_transaction_read_only"
}

Output Example

{
  "Response": {
    "Detail": [
      {
        "Advanced": true,
        "ClassificationCN": "Client Connection Defaults",
        "ClassificationEN": "Sets the default read-only status of new transactions.",
        "CurrentValue": "",
        "DefaultValue": "off",
        "EnumValue": [
          "on",
          "off"
        ],
        "ID": 59,
        "LastModifyTime": "",
        "Max": 0,
        "Min": 0,
        "Name": "default_transaction_read_only",
        "NeedReboot": false,
        "ParamDescriptionCH": "This parameter controls whether each new transaction is read-only by default. The default value is `off` (read/write)",
        "ParamDescriptionEN": "Sets the default read-only status of new transactions.",
        "ParamValueType": "bool",
        "SpecRelated": false,
        "Unit": ""
      }
    ],
    "RequestId": "",
    "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.
InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
OperationDenied.CamDeniedError This operation cannot be performed.
ResourceNotFound.InstanceNotFoundError The instance does not exist.
UnknownError Unknown error. When this error occurs, please contact customer service for assistance.
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