All Products
Search
Document Center

AnalyticDB for PostgreSQL:DescribeParameters

Last Updated:Mar 03, 2024

Queries the information about configuration parameters for an AnalyticDB for PostgreSQL instance.

Operation 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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
gpdb:DescribeParametersRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

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.
gp-bp***************

Response parameters

ParameterTypeDescriptionExample
object
Parametersobject []

The queried configuration parameters.

IsChangeableConfigstring

Indicates whether the configuration parameter can be modified. Valid values:

  • true
  • false
true
ForceRestartInstancestring

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

  • true
  • false
false
OptionalRangestring

The valid values of the configuration parameter.

[0-2147483647]
ParameterNamestring

The name of the configuration parameter.

statement_timeout
ParameterValuestring

The default value of the configuration parameter.

10800000
ParameterDescriptionstring

The description of the configuration parameter.

Sets the maximum allowed duration of any statement, A value of 0 turns off the timeout.
CurrentValuestring

The current value of the configuration parameter.

10800000
RequestIdstring

The ID of the request.

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

Examples

Sample success responses

JSONformat

{
  "Parameters": [
    {
      "IsChangeableConfig": "true",
      "ForceRestartInstance": "false",
      "OptionalRange": "[0-2147483647]",
      "ParameterName": "statement_timeout",
      "ParameterValue": "10800000",
      "ParameterDescription": "Sets the maximum allowed duration of any statement, A value of 0 turns off the timeout.",
      "CurrentValue": "10800000"
    }
  ],
  "RequestId": "62506167-D284-562A-B7C2-0A**********"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history