Check Resource Availability Before Creating an AnalyticDB PostgreSQL Instance - AnalyticDB for PostgreSQL

Gets the purchasable resources for AnalyticDB for PostgreSQL.

Operation description

Before creating an AnalyticDB for PostgreSQL instance, you can use this operation to query the available instance offerings in a specified availability zone.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

gpdb:DescribeAvailableResources

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Region	string	Yes	The region ID. Note Call the DescribeRegions API to query available region IDs.	cn-hangzhou
ZoneId	string	Yes	The availability zone ID. Note Call the DescribeRegions API to query available zone IDs.	cn-hangzhou-h
ChargeType	string	No	The billing method. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.	PostPaid

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	61DC563C-F8E4-593A-8D27-CE**********
RegionId	string	The region ID.	cn-hangzhou
Resources	array<object>	The available resources.
	array<object>	Details of an available resource.
SupportedEngines	array<object>	Details of the supported engines and instance types.
	array<object>	Details of a supported engine and its available instance types.
SupportedEngineVersion	string	The supported engine version.	6.0
SupportedInstanceClasses	array<object>	The supported instance types.
	array<object>	Details of the instance type.
Description	string	The description of the segment node instance type.	单segment节点2核配置，含16GB 内存
DisplayClass	string	The display name of the segment node instance type.	2C16G
InstanceClass	string	The instance type of the segment node.	2C16G
NodeCount	object	Details of the segment nodes.
Step	string	增加节点时的步长。例如该参数取值为 4 时，则表示增加 Segment 节点时，增加的节点数量必须为 4 的倍数。	4
MinCount	string	Segment 节点的最小值。	4
MaxCount	string	Segment 节点的最大值。	256
StorageType	string	存储类型。取值说明： cloud_essd：ESSD 云盘。 cloud_efficiency：高效云盘。 oss：OSS。	cloud_essd
StorageSize	object	Segment 存储容量。
Step	string	Segment 存储扩容步长。	50
MinCount	string	Segment 最小存储容量。	50
MaxCount	string	Segment 最大存储容量。	1000
Category	string	实例系列。取值说明： HighAvailability：高可用版。 Basic：基础版	HighAvailability
Mode	string	实例资源类型。取值说明： ecs：存储弹性模式。 serverless：Serverless 模式。	ecs
ZoneId	string	可用区 ID。	cn-hangzhou-h

Examples

Success response

JSON format

{
  "RequestId": "61DC563C-F8E4-593A-8D27-CE**********",
  "RegionId": "cn-hangzhou",
  "Resources": [
    {
      "SupportedEngines": [
        {
          "SupportedEngineVersion": "6.0",
          "SupportedInstanceClasses": [
            {
              "Description": "单segment节点2核配置，含16GB 内存",
              "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.