Queries the details of parameters in an AnalyticDB for PostgreSQL instance.

Description

This operation can be called to query the details of parameters in an AnalyticDB for PostgreSQL instance in elastic storage mode or Serverless mode.

Limits

You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered and may affect your business. We recommend that you take note of the limit when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeParameters

The operation that you want to perform. Set the value to DescribeParameters.

DBInstanceId String Yes gp-bp***************

The ID of the instance.

Note You can call the DescribeDBInstances operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.

Response parameters

Parameter Type Example Description
Parameters Array of Parameters

Details of the parameters.

IsChangeableConfig String true

Indicates whether the parameter can be modified. Valid values:

  • true
  • false
ForceRestartInstance String false

Indicates whether a restart is required for parameter modifications to take effect. Valid values:

  • true
  • false
OptionalRange String [0-2147483647]

The valid values of the parameter.

ParameterName String statement_timeout

The name of the parameter.

ParameterValue String 10800000

The default value of the parameter.

ParameterDescription String Sets the maximum allowed duration of any statement. A value of 0 turns off the timeout.

The description of the parameter.

CurrentValue String 10800000

The current value of the parameter.

RequestId String 62506167-D284-562A-B7C2-0A**********

The ID of the request.

Examples

Sample requests

http(s)://gpdb.aliyuncs.com/?Action=DescribeParameters
&DBInstanceId=gp-bp***************
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeParametersResponse>
    <Parameters>
        <OptionalRange>[0-2147483647]</OptionalRange>
        <ParameterValue>10800000</ParameterValue>
        <IsChangeableConfig>true</IsChangeableConfig>
        <CurrentValue>10800000</CurrentValue>
        <ParameterName>statement_timeout</ParameterName>
        <ParameterDescription>Sets the maximum allowed duration of any statement. A value of 0 turns off the timeout.</ParameterDescription>
        <ForceRestartInstance>false</ForceRestartInstance>
    </Parameters>
    <Parameters>
        <OptionalRange>[multi_write_ec|multi_write_sc|single]</OptionalRange>
        <ParameterValue>single</ParameterValue>
        <IsChangeableConfig>true</IsChangeableConfig>
        <CurrentValue>multi_write_ec</CurrentValue>
        <ParameterName>rds_master_mode</ParameterName>
        <ParameterDescription>Enable global strong consistency when rds_master_mode is set to multi_write_sc, and session consistency when rds_master_mode is set to multi_write_ec</ParameterDescription>
        <ForceRestartInstance>true</ForceRestartInstance>
    </Parameters>
    <RequestId>62506167-D284-562A-B7C2-0A**********</RequestId>
</DescribeParametersResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Parameters" : [ {
    "OptionalRange" : "[0-2147483647]",
    "ParameterValue" : "10800000",
    "IsChangeableConfig" : "true",
    "CurrentValue" : "10800000",
    "ParameterName" : "statement_timeout",
    "ParameterDescription" : "Sets the maximum allowed duration of any statement. A value of 0 turns off the timeout.",
    "ForceRestartInstance" : "false"
  }, {
    "OptionalRange" : "[multi_write_ec|multi_write_sc|single]",
    "ParameterValue" : "single",
    "IsChangeableConfig" : "true",
    "CurrentValue" : "multi_write_ec",
    "ParameterName" : "rds_master_mode",
    "ParameterDescription" : "Enable global strong consistency when rds_master_mode is set to multi_write_sc, and session consistency when rds_master_mode is set to multi_write_ec",
    "ForceRestartInstance" : "true"
  } ],
  "RequestId" : "62506167-D284-562A-B7C2-0A**********"
}

Error codes

For a list of error codes, visit the API Error Center.