All Products
Search
Document Center

AnalyticDB for PostgreSQL:DescribeDBInstanceAttribute

Last Updated:Mar 03, 2024

Queries the information about an AnalyticDB for PostgreSQL instance.

Operation description

You can call this operation to query the information about an AnalyticDB for PostgreSQL instance, such as the instance type, network type, and instance state.

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.

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

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceGroupIdstringNo

This parameter is no longer used.

rg-bp67acfmxazb4p****
DBInstanceIdstringYes

The instance ID.

Note You can call the DescribeDBInstances operation to query the IDs of all AnalyticDB for PostgreSQL instances within a region.
gp-bp13ue79qk8y1****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68
Itemsobject []

The queried instance.

VpcIdstring

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

vpc-bp19ame5m1r3oejns****
CreationTimestring

The time when the instance was created.

2022-08-11T09:16:26Z
DBInstanceCpuCoresinteger

The number of CPU cores.

2
SegmentCountsinteger

The number of compute groups.

Note This parameter is returned only for instances in reserved storage mode.
0
StoragePerNodeinteger

The storage capacity per node. The unit of this parameter can be one of the valid values of StorageUnit.

Note This parameter is returned only for instances in reserved storage mode.
0
DBInstanceMemorylong

The memory capacity per compute node.

Note The unit of this parameter is MB for instances in reserved storage mode and GB for instances in Serverless mode or elastic storage mode.
16
HostTypestring

The disk type of the compute group. Valid values:

  • 0: SSD.
  • 1: HDD.
Note This parameter is returned only for instances in reserved storage mode.
0
PayTypestring

The billing method of the instance. Valid values:

  • Postpaid: pay-as-you-go.
  • Prepaid: subscription.
Postpaid
Tagsobject []

The tags of the instance. Each tag is a key-value pair.

Keystring

The tag key.

test-key
Valuestring

The tag value.

test-value
StorageTypestring

The storage type of the instance. Valid values:

  • cloud_essd: enhanced SSD (ESSD).
  • cloud_efficiency: ultra disk.
Note This parameter is returned only for instances in elastic storage mode.
cloud_essd
AvailabilityValuestring

The service availability of the instance. Unit: %.

Note This parameter is returned only for instances in reserved storage mode.
100.0%
ReadDelayTimestring

An invalid parameter. It is no longer returned when you call this operation.

null
CpuCoresPerNodeinteger

The number of CPU cores per node.

Note This parameter is returned only for instances in reserved storage mode.
0
Portstring

The port number that is used to connect to the instance.

5432
ConnectionModestring

The access mode of the instance. Valid values:

  • Performance: standard mode.
  • Safety: safe mode.
  • LVS: Linux Virtual Server (LVS) mode.
LVS
LockModestring

The lock mode of the instance. Valid values:

  • Unlock: The instance is not locked.
  • ManualLock: The instance is manually locked.
  • LockByExpiration: The instance is automatically locked due to instance expiration.
  • LockByRestoration: The instance is automatically locked due to instance restoration.
  • LockByDiskQuota: The instance is automatically locked due to exhausted storage.
Unlock
EngineVersionstring

The version of the database engine.

6.0
StorageUnitstring

The unit of the storage capacity. Valid values:

  • GB SSD
  • TB SSD
  • GB HDD
Note This parameter is returned only for instances in reserved storage mode.
GB SSD
MemoryPerNodeinteger

The memory capacity per node. The unit of this parameter can be one of the valid values of MemoryUnit.

Note This parameter is returned only for instances in reserved storage mode.
0
ConnectionStringstring

The endpoint that is used to connect to the instance.

gp-bp13ue79qk8y1****-master.gpdb.rds.aliyuncs.com
InstanceNetworkTypestring

The network type of the instance. Valid values:

  • Classic: classic network.
  • VPC: VPC.
VPC
SecurityIPListstring

An invalid parameter. It is no longer returned when you call this operation.

127.0.0.1
MemoryUnitstring

The unit of the memory capacity.

Note This parameter is returned only for instances in reserved storage mode.
GB
DBInstanceClassTypestring

The instance family of the instance. Valid values:

  • s: shared.
  • x: general-purpose.
  • d: dedicated.
  • h: dedicated host.
x
DBInstanceDescriptionstring

The description of the instance.

gp-bp13ue79qk8y1****
DBInstanceGroupCountstring

The number of compute groups.

Note This parameter is returned only for instances in reserved storage mode.
0
ExpireTimestring

The expiration time of the instance. The time is displayed in UTC.

Note The expiration time of a pay-as-you-go instance is 2999-09-08T16:00:00Z.
2999-09-08T16:00:00Z
DBInstanceNetTypestring

An invalid parameter. It is no longer returned when you call this operation.

2
MaintainStartTimestring

The start time of the maintenance window of the instance.

18:00Z
MaintainEndTimestring

The end time of the maintenance window of the instance.

22:00Z
LockReasonstring

An invalid parameter. It is no longer returned when you call this operation.

null
DBInstanceStatusstring

The state of the instance. For more information, see the "Additional description of DBInstanceStatus" section of this topic.

Running
RegionIdstring

The region ID of the instance.

cn-hangzhou
DBInstanceDiskMBPSlong

The maximum disk throughput of the compute group. Unit: Mbit/s.

Note This parameter is returned only for instances in reserved storage mode.
0
DBInstanceStoragelong

The maximum storage capacity per node. Unit: GB.

50
ZoneIdstring

The zone ID of the instance.

cn-hangzhou-j
MaxConnectionsinteger

The maximum number of concurrent connections to the instance.

Note This parameter is returned only for instances in reserved storage mode.
500
DBInstanceIdstring

The instance ID.

gp-bp13ue79qk8y1****
DBInstanceClassstring

The instance type of the instance.

Note This parameter is returned only for instances in reserved storage mode.
gpdb.group.segsdx1
Enginestring

The database engine of the instance.

gpdb
DBInstanceCategorystring

The edition of the instance. Valid values:

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

The number of CPU cores per compute node.

2
MemorySizelong

The memory capacity per compute node.

Note The unit of this parameter is MB for instances in reserved storage mode and GB for instances in Serverless mode or elastic storage mode.
16
StorageSizelong

The storage capacity of the instance. Unit: GB.

50
SegNodeNuminteger

The number of compute nodes.

Note This parameter is returned only for instances in elastic storage mode or Serverless manual scheduling mode.
4
MasterNodeNuminteger

The number of coordinator nodes.

1
DBInstanceModestring

The resource type of the instance. Valid values:

  • Serverless: Serverless mode.
  • StorageElastic: elastic storage mode.
  • Classic: reserved storage mode.
StorageElastic
MinorVersionstring

The minor version of the instance.

6.3.10.1-202207141918
SupportRestoreboolean

Indicates whether the instance supports backup and restoration. Valid values:

  • true
  • false
true
VSwitchIdstring

The vSwitch ID of the instance.

vsw-bp1cpq8mr64paltkb****
EncryptionKeystring

The encryption key.

Note This parameter is returned only for instances that have disk encryption enabled.
0d2470df-da7b-4786-b981-************
EncryptionTypestring

The encryption type. Valid values:

  • CloudDisk: disk encryption.
Note This parameter is returned only for instances that have disk encryption enabled.
CloudDisk
CoreVersionstring

The number of the minor version.

mm.v6.3.10.1-202207141918
RunningTimestring

The running duration of the instance.

4 days 22:58:55
StartTimestring

The time when the instance started to run.

2022-08-11T09:26:43Z
ResourceGroupIdstring

The ID of the resource group to which the instance belongs.

rg-bp67acfmxazb4p****
ServerlessResourceinteger

The threshold of computing resources. Unit: AnalyticDB compute units (ACUs).

Note This parameter is returned only for instances in Serverless automatic scheduling mode.
32
IdleTimeinteger

The wait period for the instance that has no traffic to become idle. Unit: seconds.

Note This parameter is returned only for instances in Serverless automatic scheduling mode.
600
ServerlessModestring

The type of the Serverless mode. Valid values:

  • Manual: manual scheduling.
  • Auto: automatic scheduling.
Note This parameter is returned only for instances in Serverless mode.
Auto
SegDiskPerformanceLevelstring

The performance level of ESSDs. Only PL1 is supported.

PL1
VectorConfigurationStatusstring

Indicates whether vector search engine optimization is enabled. Valid values:

  • enabled
  • disabled
enabled
MasterCUinteger

The amount of coordinator node resources.

4

Additional description of DBInstanceStatus

Values of DBInstanceStatus:

  • Creating
  • Running
  • Deleting
  • Rebooting
  • DBInstanceClassChanging
  • Transfering
  • EngineVersionUpgrading
  • TransferingToOtherInstance
  • GuardDBInstanceCreating
  • Restoring
  • Importing
  • ImportingFromOtherInstance
  • DBInstanceNetTypeChangin
  • GuardSwitching

Examples

Sample success responses

JSONformat

{
  "RequestId": "5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68",
  "Items": {
    "DBInstanceAttribute": [
      {
        "VpcId": "vpc-bp19ame5m1r3oejns****",
        "CreationTime": "2022-08-11T09:16:26Z",
        "DBInstanceCpuCores": 2,
        "SegmentCounts": 0,
        "StoragePerNode": 0,
        "DBInstanceMemory": 16,
        "HostType": "0",
        "PayType": "Postpaid",
        "Tags": {
          "Tag": [
            {
              "Key": "test-key",
              "Value": "test-value"
            }
          ]
        },
        "StorageType": "cloud_essd",
        "AvailabilityValue": "100.0%",
        "ReadDelayTime": "null",
        "CpuCoresPerNode": 0,
        "Port": "5432",
        "ConnectionMode": "LVS",
        "LockMode": "Unlock",
        "EngineVersion": "6.0",
        "StorageUnit": "GB SSD",
        "MemoryPerNode": 0,
        "ConnectionString": "gp-bp13ue79qk8y1****-master.gpdb.rds.aliyuncs.com",
        "InstanceNetworkType": "VPC",
        "SecurityIPList": "127.0.0.1",
        "MemoryUnit": "GB",
        "DBInstanceClassType": "x",
        "DBInstanceDescription": "gp-bp13ue79qk8y1****",
        "DBInstanceGroupCount": "0",
        "ExpireTime": "2999-09-08T16:00:00Z",
        "DBInstanceNetType": "2",
        "MaintainStartTime": "18:00Z",
        "MaintainEndTime": "22:00Z",
        "LockReason": "null",
        "DBInstanceStatus": "Running",
        "RegionId": "cn-hangzhou",
        "DBInstanceDiskMBPS": 0,
        "DBInstanceStorage": 50,
        "ZoneId": "cn-hangzhou-j",
        "MaxConnections": 500,
        "DBInstanceId": "gp-bp13ue79qk8y1****",
        "DBInstanceClass": "gpdb.group.segsdx1",
        "Engine": "gpdb",
        "DBInstanceCategory": "HighAvailability",
        "CpuCores": 2,
        "MemorySize": 16,
        "StorageSize": 50,
        "SegNodeNum": 4,
        "MasterNodeNum": 1,
        "DBInstanceMode": "StorageElastic",
        "MinorVersion": "6.3.10.1-202207141918",
        "SupportRestore": true,
        "VSwitchId": "vsw-bp1cpq8mr64paltkb****",
        "EncryptionKey": "0d2470df-da7b-4786-b981-************",
        "EncryptionType": "CloudDisk",
        "CoreVersion": "mm.v6.3.10.1-202207141918",
        "RunningTime": "4 days 22:58:55",
        "StartTime": "2022-08-11T09:26:43Z",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "ServerlessResource": 32,
        "IdleTime": 600,
        "ServerlessMode": "Auto",
        "SegDiskPerformanceLevel": "PL1",
        "VectorConfigurationStatus": "enabled",
        "MasterCU": 4
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-01-04The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-08-17The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2023-05-23The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.