Use DescribeDBInstanceAttribute to query instance details - AnalyticDB - Alibaba Cloud - AnalyticDB

Queries the details of an AnalyticDB for PostgreSQL instance.

Operation description

How-To

View the specifications, network type, status, and other details of an AnalyticDB for PostgreSQL instance.

Queries per second (QPS) limit

The default QPS limit for this API is 1,000 queries per second per user. Exceeding this limit triggers rate limiting, which may affect your business.

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:DescribeDBInstanceAttribute

get

*DBInstance

acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	This parameter is deprecated and does not need to be specified.	null
DBInstanceId	string	Yes	Instance ID. Note You can invoke the DescribeDBInstances API to view the instance IDs of all AnalyticDB for PostgreSQL instances in the destination region.	gp-bp13ue79qk8y1****

Response elements

Element	Type	Description	Example
	object
Items	object
DBInstanceAttribute	array<object>	List of instance details.
	array<object>	Details.
AvailabilityValue	string	Current instance availability, in percentage (%). Note This parameter applies only to instances in reserved storage mode.	100.0%
ConnectionMode	string	Access mode. Valid values: Performance: Standard access mode. Safty: High-security access mode. LVS: LVS link mode.	LVS
ConnectionString	string	Connection address of the instance.	gp-bp13ue79qk8y1****-master.gpdb.rds.aliyuncs.com
CoreVersion	string	The minor engine version number.	mm.v6.3.10.1-202207141918
CpuCores	integer	Number of CPU cores on the compute node.	2
CpuCoresPerNode	integer	The number of CPU cores per node. Note This parameter applies only to instances in reserved storage mode.	0
CreationTime	string	Creation time of the instance.	2022-08-11T09:16:26Z
DBInstanceCategory	string	The instance edition. Valid values: Basic: Basic Edition. HighAvailability: High-availability Edition.	HighAvailability
DBInstanceClass	string	Instance type. Note This parameter applies only to instances in storage reserved mode.	gpdb.group.segsdx1
DBInstanceClassType	string	The instance family. Valid values: s: Shared type. x: General-purpose type. d: Dedicated plan. h: Dedicated physical machine.	x
DBInstanceCpuCores	integer	Number of CPU cores.	2
DBInstanceDescription	string	Instance description.	gp-bp13ue79qk8y1****
DBInstanceDiskMBPS	integer	Maximum BPS (disk throughput) of the compute group, in Mbps. Note This parameter applies only to instances in storage-reserved mode.	0
DBInstanceGroupCount	string	The number of compute groups. Note This parameter applies only to instances in reserved storage mode.	0
DBInstanceId	string	Instance ID.	gp-bp13ue79qk8y1****
DBInstanceMemory	integer	The memory of the compute node. Note The unit is MB for reserved storage mode, and GB for Serverless and elastic storage modes.	16
DBInstanceMode	string	Resource type of the instance. Valid values: Serverless: Serverless mode. StorageElastic: Storage elasticity mode. Classic: Reserved storage mode.	StorageElastic
DBInstanceNetType	string	This parameter is deprecated and will not return a value.	null
DBInstanceStatus	string	Instance status. For more information, see the supplementary description of the DBInstanceStatus parameter.	Running
DBInstanceStorage	integer	Maximum storage space per replica, in GB.	50
DeployMode	string	Deployment mode.	single
EncryptionKey	string	Encryption Key. Note This parameter is returned only for instances with disk encryption enabled.	0d2470df-da7b-4786-b981-************
EncryptionType	string	Encryption Type. Valid values: CloudDisk: disk encryption. Note This parameter is returned only for instances with disk encryption enabled.	CloudDisk
Engine	string	Database engine.	gpdb
EngineVersion	string	Database version.	6.0
ExpireTime	string	Expiration time of the instance (UTC). Note The expiration time for a pay-as-you-go instance is `2999-09-08T16:00:00Z`.	2999-09-08T16:00:00Z
HostType	string	Compute group machine type. Valid values: 0: SSD 1: HDD Note This parameter applies only to instances in storage reservation mode.	0
IdleTime	integer	Idle release wait time, in seconds. Note This parameter is returned only for instances in Serverless auto-scheduling mode.	600
InstanceNetworkType	string	The network type of the instance. Valid values: Classic: classic network. VPC: VPC network.	VPC
LockMode	string	The lock mode. Valid values: Unlock: Normal. ManualLock: Locked manually. LockByExpiration: Automatically locked when the instance expires. LockByRestoration: Automatically locked before instance rollback. LockByDiskQuota: Automatically locked when the instance storage space is full.	Unlock
LockReason	string	Deprecated. No value is returned.	null
MaintainEndTime	string	Maintenance end time.	22:00Z
MaintainStartTime	string	Start time of the maintenance window.	18:00Z
MasterCU	integer	Master resources.	4
MasterNodeNum	integer	Number of master nodes.	1
MaxConnections	integer	Maximum number of concurrent connections for the instance. Note This parameter applies only to instances in storage reserved mode.	500
MemoryPerNode	integer	The memory size per replica. For the unit, see the MemoryUnit parameter. Note This parameter applies only to instances in reserved storage mode.	0
MemorySize	integer	Memory size of the compute node. Note The unit is MB for reserved storage mode, and GB for Serverless and elastic storage modes.	16
MemoryUnit	string	Memory unit. Note This parameter applies only to instances in reserved storage mode.	GB
MinorVersion	string	Minor engine version.	6.3.10.1-202207141918
PayType	string	The billing type. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.	Postpaid
Port	string	The port number of the instance.	5432
ProdType	string	Product type.	standard
ReadDelayTime	string	Deprecated. No value is returned.	null
RegionId	string	Region ID.	cn-hangzhou
ResourceGroupId	string	The ID of the resource group to which the instance belongs.	rg-bp67acfmxazb4p****
RunningTime	string	Running duration of the instance.	4 days 22:58:55
SecurityIPList	string	This parameter is deprecated and will not return a value.	null
SegDiskPerformanceLevel	string	Performance level (PL). Only PL1 is currently supported.	PL1
SegNodeNum	integer	The number of segment nodes. Note This parameter applies only to instances in elastic storage mode and Serverless mode with manual scheduling.	4
SegmentCounts	integer	Number of compute groups. Note This parameter applies only to instances in storage-reserved mode.	0
ServerlessMode	string	Serverless instance mode. Valid values: Manual: manual schedule. Auto: auto schedule. Note This parameter is returned only for Serverless instances. The auto schedule mode for AnalyticDB for PostgreSQL Serverless is currently in invitational preview. To use this feature, submit a ticket to request access.	Auto
ServerlessResource	integer	Computing resource threshold, measured in ACUs. Note This parameter is returned only for instances in Serverless auto-scheduling mode.	32
StandbyZoneId	string	Secondary zone ID.	cn-hangzhou-i
StartTime	string	The time when the instance started running.	2022-08-11T09:26:43Z
StoragePerNode	integer	Storage size per replica. For the unit, see the StorageUnit parameter. Note This parameter applies only to instances in reserved storage mode.	0
StorageSize	integer	Bucket size, in GB.	50
StorageType	string	Storage class. Valid values: cloud_essd: enterprise SSD (ESSD). cloud_efficiency: ultra disk. Note This parameter applies only to instances in storage elasticity mode.	cloud_essd
StorageUnit	string	Storage unit. Valid values: GB SSD TB SSD GB HDD Note This parameter applies only to instances in reserved storage mode.	GB SSD
SupportRestore	boolean	Indicates whether backup recovery is supported. Valid values: true: Backup recovery is supported. false: Backup recovery is not supported.	true
Tags	object
Tag	array<object>	Key-value pairs of tags.
	object	Tag details.
Key	string	Tag key.	test-key
Value	string	Tag value.	test-value
VSwitchId	string	vSwitch ID.	vsw-bp1cpq8mr64paltkb****
VectorConfigurationStatus	string	Indicates whether vector engine optimization is enabled. Valid values: enabled: Vector engine optimization is enabled. disabled: Vector engine optimization is disabled.	enabled
VpcId	string	The VPC ID.	vpc-bp19ame5m1r3oejns****
ZoneId	string	Zone ID.	cn-hangzhou-j
SegmentAISpec	string	Compute AI node specifications of the instance. If the compute node is not an AI node, an empty value is returned.	ADB.AIMedium.2
MasterAISpec	string	Master AI node specifications of the instance. If the master node is not an AI node, an empty value is returned.	ADB.AIMedium.2
CacheStorageSize	string	Total cache disk size, in GB.	64
InstanceSpec	string	Node specifications of the compute node.	2C16G
GraphEngineStatus	string	Indicates whether the graph engine is enabled. Valid values: enabled: The graph engine is enabled. disabled: The graph engine is disabled.	enabled
RequestId	string	Request ID.	5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68

Additional description of the DBInstanceStatus parameter

Valid values for the DBInstanceStatus parameter:

Creating: Creation in progress.
Running: In use.
Deleting: Deletion in progress.
Rebooting: Restart in progress.
DBInstanceClassChanging: Scaling up or down in progress.
Transfering: Migration in progress.
EngineVersionUpgrading: Version upgrade in progress.
TransferingToOtherInstance: Migrating data to another AnalyticDB for PostgreSQL instance.
GuardDBInstanceCreating: Creating a disaster recovery instance.
Restoring: Backup restoration in progress.
Importing: Data import in progress.
ImportingFromOtherInstance: Importing data from another AnalyticDB for PostgreSQL instance.
DBInstanceNetTypeChangin: Switching between internal and public network types.
GuardSwitching: Switchover in progress.

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.