All Products
Search
Document Center

AnalyticDB for PostgreSQL:DescribeAvailableResources

Last Updated:Mar 03, 2024

Queries the information about available resources of AnalyticDB for PostgreSQL.

Operation description

When you create an AnalyticDB for PostgreSQL instance, you can call this operation to query the available resources within a zone.

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:DescribeAvailableResourcesRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionstringYes

The region ID.

Note You can call the DescribeRegions operation to query the most recent region list.
cn-hangzhou
ZoneIdstringYes

The zone ID.

Note You can call the DescribeRegions operation to query the most recent zone list.
cn-hangzhou-h
ChargeTypestringNo

The billing method. Valid values:

  • Postpaid: pay-as-you-go.
  • Prepaid: subscription.
PostPaid

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

61DC563C-F8E4-593A-8D27-CE**********
RegionIdstring

The region ID.

cn-hangzhou
Resourcesobject []

The zone ID.

SupportedEnginesobject []

The available engine version and specifications.

SupportedEngineVersionstring

The available engine version.

6.0
SupportedInstanceClassesobject []

The available specifications.

Descriptionstring

The description of compute node specifications.

DisplayClassstring

The specifications of each compute node.

2C16G
InstanceClassstring

The specifications of each compute node.

2C16G
NodeCountobject

Details about the compute nodes.

Stepstring

The step size for adding compute nodes.

For example, if the value of this parameter is 4, compute nodes must be added by multiples of 4.

4
MinCountstring

The minimum number of compute nodes.

4
MaxCountstring

The maximum number of compute nodes.

256
StorageTypestring

The storage type. Valid values:

  • cloud_essd: enhanced SSD (ESSD)
  • cloud_efficiency: ultra disk
  • oss: Object Storage Service (OSS)
cloud_essd
StorageSizeobject

Details about the storage capacity of compute nodes.

Stepstring

The step size for adding storage capacity for compute nodes.

50
MinCountstring

The minimum storage capacity of each compute node.

50
MaxCountstring

The maximum storage capacity of each compute node.

1000
Categorystring

The instance edition. Valid values:

  • HighAvailability: High-availability Edition
  • Basic: Basic Edition
HighAvailability
Modestring

The instance resource type. Valid values:

  • ecs: elastic storage mode
  • serverless: Serverless mode
ecs
ZoneIdstring

The ID of the zone.

cn-hangzhou-h

Examples

Sample success responses

JSONformat

{
  "RequestId": "61DC563C-F8E4-593A-8D27-CE**********",
  "RegionId": "cn-hangzhou",
  "Resources": [
    {
      "SupportedEngines": [
        {
          "SupportedEngineVersion": "6.0",
          "SupportedInstanceClasses": [
            {
              "Description": "",
              "DisplayClass": "2C16G",
              "InstanceClass": "2C16G",
              "NodeCount": {
                "Step": "4",
                "MinCount": "4",
                "MaxCount": "256"
              },
              "StorageType": "cloud_essd",
              "StorageSize": {
                "Step": "50",
                "MinCount": "50",
                "MaxCount": "1000"
              },
              "Category": "HighAvailability"
            }
          ],
          "Mode": "ecs"
        }
      ],
      "ZoneId": "cn-hangzhou-h"
    }
  ]
}

Error codes

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