Queries the specifications of an AnalyticDB for PostgreSQL instance.

Description

This operation is available only for AnalyticDB for PostgreSQL instances in reserved storage 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. As a result, your business may be affected. 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 DescribeSpecification

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

DBInstanceId String No gp-bp***************

The ID of the instance in reserved storage mode.

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

The storage type of the instance. Valid values:

  • SSD
  • HDD
CpuCores Integer Yes 1

The number of CPU cores.

TotalNodeNum Integer Yes 2

The number of compute nodes.

Response parameters

Parameter Type Example Description
StorageNotice Array of StorageNotice

Details about the storage capacity of compute groups.

Value String 2 CPU Cores/16GB Memory/160GB SSD Storage

The storage capacity of compute groups.

Text String 2 CPU Cores/16GB Memory/160GB SSD Storage

The storage capacity of compute groups.

RequestId String 2EC38F35-C2D3-56A1-A49E-61**********

The ID of the request.

DBInstanceClass Array of DBInstanceClass

Details about the specifications of compute nodes.

Value String 1x1C SSD

The specifications of compute nodes.

Text String gpdb.group.segsdx1

The instance type of compute nodes.

DBInstanceGroupCount Array of DBInstanceGroupCount

Details about compute groups.

Value String 2

The number of compute groups.

Text String 2

The number of compute groups.

Examples

Sample requests

http(s)://gpdb.aliyuncs.com/?Action=DescribeSpecification
&StorageType=SSD
&CpuCores=1
&TotalNodeNum=2
&<Common request parameters>

Sample success responses

XML format 

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

<DescribeSpecificationResponse>
    <StorageNotice>
        <Value>2 CPU Cores/16GB Memory/160GB SSD Storage</Value>
        <Text>2 CPU Cores/16GB Memory/160GB SSD Storage</Text>
    </StorageNotice>
    <RequestId>2EC38F35-C2D3-56A1-A49E-61**********</RequestId>
    <DBInstanceClass>
        <Value>gpdb.group.segsdx1</Value>
        <Text>1x1C SSD</Text>
    </DBInstanceClass>
    <DBInstanceGroupCount>
        <Value>2</Value>
        <Text>2</Text>
    </DBInstanceGroupCount>
</DescribeSpecificationResponse>

JSON format 

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

{
  "StorageNotice" : [ {
    "Value" : "2 CPU Cores/16GB Memory/160GB SSD Storage",
    "Text" : "2 CPU Cores/16GB Memory/160GB SSD Storage"
  } ],
  "RequestId" : "2EC38F35-C2D3-56A1-A49E-61**********",
  "DBInstanceClass" : [ {
    "Value" : "gpdb.group.segsdx1",
    "Text" : "1x1C SSD"
  } ],
  "DBInstanceGroupCount" : [ {
    "Value" : "2",
    "Text" : "2"
  } ]
}

Error codes

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