Queries the details of an AnalyticDB for PostgreSQL instance in elastic storage mode.

Description

This operation is called to query the instance type, network type, and status of an AnalyticDB for PostgreSQL instance in elastic storage mode.

To query the details of an AnalyticDB for PostgreSQL instance in reserved storage mode, call the DescribeDBInstanceAttribute operation.

Limit

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 DescribeDBInstanceOnECSAttribute

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

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 within a specific region, including instance IDs.

Response parameters

Parameter Type Example Description
RequestId String 5850BF81-1A2B-5ACE-AF41-57**********

The ID of the request.

Items Array of DBInstanceAttribute

Details of the instance.

DBInstanceAttribute
CreationTime String 2021-09-15T08:30:00Z

The time when the instance was created.

VpcId String vpc-bp*******************

The virtual private cloud (VPC) ID of the instance.

EncryptionType String CloudDisk

The type of the encryption. Valid values:

  • Default value: NULL. Encryption is disabled.
  • CloudDisk: Encryption is enabled on disks and the encryption key is specified by using the EncryptionKey parameter.
Notice Disk encryption cannot be disabled after it is enabled.
InstanceDeployType String cluster

The deployment type of the instance.

  • cluster: elastic storage mode
PayType String Prepaid

The billing method of the instance. Valid values:

  • Postpaid: pay-as-you-go
  • Prepaid: subscription
Tags Array of Tag

The list of one or more tags. Each tag consists of a key-value pair.

Tag
Key String test-key

The tag key of the instance.

Value String test-value

The tag value of the instance.

StorageType String cloud_essd

The storage type of the instance. Valid values:

  • cloud_essd: enhanced SSD (ESSD)
  • cloud_efficiency: ultra disk
ConnectionMode String LVS

The access mode. Valid values:

  • LVS: Linux Virtual Server (LVS) mode
  • Standard: standard mode
  • Safety: safe mode
Port String 5432

The port that is used to connect to the instance.

LockMode String Unlock

The lock mode of the instance. Valid values:

  • Unlock: The instance is not locked.
  • ManualLock: The instance was manually locked.
  • LockByExpiration: The instance was locked automatically due to the instance expiring.
  • LockByRestoration: The instance was locked automatically before a rollback.
  • LockByDiskQuota: The instance was locked automatically when the disk space is full.
  • LockReadInstanceByDiskQuota: The instance is a read-only instance that is automatically locked when the disk space is full.
EngineVersion String 6.0

The version of the database engine.

MemorySize Integer 16

The memory capacity per compute node. Unit: GB.

SegNodeNum Integer 4

The number of compute nodes.

ConnectionString String gp-bp***************-master.gpdb.rds.aliyuncs.com

The endpoint that is used to connect to the instance.

InstanceNetworkType String VPC

The network type of the instance. Valid values:

  • Classic
  • VPC
EncryptionKey String 9fc356bf-b59c-42e0-9659-************

The ID of the encryption key. If disk encryption is disabled, this parameter is empty.

DBInstanceDescription String gp-bp***************

The description of the instance.

CpuCores Integer 2

The number of CPU cores per compute node.

ExpireTime String 2021-10-15T16:00:00Z

The expiration time of the instance.

DBInstanceStatus String Running

The status of the instance. For more information, see Instance statuses.

StorageSize Integer 50

The storage capacity of the instance. Unit: GB.

RegionId String cn-hangzhou

The region ID of the instance.

VSwitchId String vsw-bp*******************

The vSwitch ID of the instance.

ZoneId String cn-hangzhou-h

The zone ID of the instance.

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

The ID of the instance.

Engine String gpdb

The database engine of the instance.

DBInstanceClass String adbpg.cluster.eni.2c16g

The instance type of the instance.

SupportRestore Boolean true

Indicates whether the instance supports backup and restoration.

  • true: The instance supports backup and restoration.
  • false: The instance does not support backup and restoration.
MinorVersion String 6.3.4.10-202109231235

The version of the instance.

MasterNodeNum Integer 1

The number of coordinator nodes.

DBInstanceCategory String HighAvailability

The edition of the instance. Valid values:

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

Examples

Sample requests

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

Sample success responses

XML format

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

<DescribeDBInstanceOnECSAttributeResponse>
    <RequestId>5850BF81-1A2B-5ACE-AF41-57**********</RequestId>
    <Items>
        <DBInstanceAttribute>
            <MasterNodeNum>1</MasterNodeNum>
            <Port>5432</Port>
            <SegNodeNum>4</SegNodeNum>
            <EncryptionKey>9fc356bf-b59c-42e0-9659-************</EncryptionKey>
            <InstanceNetworkType>VPC</InstanceNetworkType>
            <SupportRestore>true</SupportRestore>
            <DBInstanceCategory>HighAvailability</DBInstanceCategory>
            <DBInstanceId>gp-bp***************</DBInstanceId>
            <DBInstanceDescription>gp-bp***************</DBInstanceDescription>
            <Engine>gpdb</Engine>
            <Tags>
                <Tag>
                    <Value>test-value</Value>
                    <Key>test-key</Key>
                </Tag>
            </Tags>
            <MemorySize>16</MemorySize>
            <EncryptionType>CloudDisk</EncryptionType>
            <StorageType>cloud_essd</StorageType>
            <EngineVersion>6.0</EngineVersion>
            <DBInstanceStatus>Running</DBInstanceStatus>
            <ZoneId>cn-hangzhou-h</ZoneId>
            <DBInstanceClass>adbpg.cluster.eni.2c16g</DBInstanceClass>
            <VSwitchId>vsw-bp*******************</VSwitchId>
            <StorageSize>50</StorageSize>
            <MinorVersion>6.3.4.10-202109231235</MinorVersion>
            <PayType>Prepaid</PayType>
            <LockMode>Unlock</LockMode>
            <VpcId>vpc-bp*******************</VpcId>
            <CreationTime>2021-09-15T08:30:00Z</CreationTime>
            <InstanceDeployType>cluster</InstanceDeployType>
            <ConnectionMode>LVS</ConnectionMode>
            <CpuCores>2</CpuCores>
            <RegionId>cn-hangzhou</RegionId>
            <ConnectionString>gp-bp***************-master.gpdb.rds.aliyuncs.com</ConnectionString>
            <ExpireTime>2021-10-15T16:00:00Z</ExpireTime>
        </DBInstanceAttribute>
    </Items>
</DescribeDBInstanceOnECSAttributeResponse>

JSON format

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

{
  "RequestId" : "5850BF81-1A2B-5ACE-AF41-57**********",
  "Items" : {
    "DBInstanceAttribute" : [ {
      "MasterNodeNum" : 1,
      "Port" : "5432",
      "SegNodeNum" : 4,
      "EncryptionKey" : "9fc356bf-b59c-42e0-9659-************",
      "InstanceNetworkType" : "VPC",
      "SupportRestore" : true,
      "DBInstanceCategory" : "HighAvailability",
      "DBInstanceId" : "gp-bp***************",
      "DBInstanceDescription" : "gp-bp***************",
      "Engine" : "gpdb",
      "Tags" : {
        "Tag" : [ {
          "Value" : "test-value",
          "Key" : "test-key"
        } ]
      },
      "MemorySize" : 16,
      "EncryptionType" : "CloudDisk",
      "StorageType" : "cloud_essd",
      "EngineVersion" : "6.0",
      "DBInstanceStatus" : "Running",
      "ZoneId" : "cn-hangzhou-h",
      "DBInstanceClass" : "adbpg.cluster.eni.2c16g",
      "VSwitchId" : "vsw-bp*******************",
      "StorageSize" : 50,
      "MinorVersion" : "6.3.4.10-202109231235",
      "PayType" : "Prepaid",
      "LockMode" : "Unlock",
      "VpcId" : "vpc-bp*******************",
      "CreationTime" : "2021-09-15T08:30:00Z",
      "InstanceDeployType" : "cluster",
      "ConnectionMode" : "LVS",
      "CpuCores" : 2,
      "RegionId" : "cn-hangzhou",
      "ConnectionString" : "gp-bp***************-master.gpdb.rds.aliyuncs.com",
      "ExpireTime" : "2021-10-15T16:00:00Z"
    } ]
  }
}

Error codes

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