DescribeDBInstanceOnECSAttribute

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.

Request parameters

Response parameters

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.