DescribeDBInstanceAttribute - AnalyticDB

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Query detailed information about the instance

Operation description

Usage Instructions

This interface is generally used to view information such as the specifications, network type, and instance status of AnalyticDB for PostgreSQL instances.

QPS Limitation

The default single-user QPS limit for this interface is 1000 times/second. If the limit is exceeded, API calls will be throttled, which may affect your business. Please use it reasonably.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
gpdb:DescribeDBInstanceAttribute	get	DBInstance acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	This parameter is deprecated and should not be passed.	null
DBInstanceId	string	Yes	Instance ID. Note You can call the DescribeDBInstances interface to view the instance IDs of all AnalyticDB for PostgreSQL instances in the target region.	gp-bp13ue79qk8y1****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	Request ID.	5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68
Items	array<object>	The queried instance.
DBInstanceAttribute	object	The queried instance.
VpcId	string	VPC ID.	vpc-bp19ame5m1r3oejns****
CreationTime	string	Instance creation time.	2022-08-11T09:16:26Z
DBInstanceCpuCores	integer	Number of CPU cores.	2
SegmentCounts	integer	Number of compute groups. Note This parameter applies only to storage-reserved mode instances.	0
StoragePerNode	integer	Storage size per replica, see the StorageUnit parameter for units. Note This parameter applies only to storage-reserved mode instances.	0
DBInstanceMemory	long	Memory of the compute node. Note The unit for storage-reserved mode is MB; for Serverless and storage-elastic modes, it is GB.	16
HostType	string	Compute group machine type, with the following values: 0: SSD 1: HDD Note This parameter applies only to storage-reserved mode instances.	0
PayType	string	Billing type, with the following values: Postpaid: Pay-as-you-go. Prepaid: Subscription.	Postpaid
Tags	array<object>	Tag key-value pairs.
Tag	object	The details of the tags are as follows.
Key	string	Tag key.	test-key
Value	string	Tag value.	test-value
StorageType	string	Storage type, with the following values: cloud_essd: ESSD cloud disk. cloud_efficiency: Efficient cloud disk. Note This parameter is only applicable to instances in the storage elastic mode.	cloud_essd
AvailabilityValue	string	Queries the current instance availability status, in percentage (%). Note This parameter is only applicable to instances in the storage reserved mode.	100.0%
ReadDelayTime	string	This parameter has been deprecated and will not return a value.	null
CpuCoresPerNode	integer	Number of CPU cores per node. Note This parameter is only applicable to instances in the storage reserved mode.	0
Port	string	Instance port number.	5432
ConnectionMode	string	Access mode, with the following values: Performance: Standard access mode. Safty: High-security access mode. LVS: LVS link mode.	LVS
LockMode	string	Lock mode, with the following values: Unlock: Normal. ManualLock: Manually triggered lock. LockByExpiration: Automatically locked when the instance expires. LockByRestoration: Automatically locked before the instance rolls back. LockByDiskQuota: Automatically locked when the instance space is full.	Unlock
EngineVersion	string	Database version.	6.0
StorageUnit	string	Storage unit, with the following values: GB SSD TB SSD GB HDD Note This parameter is only applicable to instances in the storage reserved mode.	GB SSD
MemoryPerNode	integer	Memory size per replica, see the MemoryUnit parameter for the unit. Note This parameter is only applicable to instances in the storage reserved mode.	0
ConnectionString	string	Instance connection address.	gp-bp13ue79qk8y1****-master.gpdb.rds.aliyuncs.com
InstanceNetworkType	string	Instance network type, with the following values: Classic: Classic network. VPC: VPC network.	VPC
SecurityIPList	string	This parameter is deprecated and will not return any value.	null
MemoryUnit	string	Memory unit. Note This parameter is only applicable to reserved storage mode instances.	GB
DBInstanceClassType	string	Instance family, with the following values: s: Shared type. x: General type. d: Dedicated package. h: Dedicated physical machine.	x
DBInstanceDescription	string	Instance description.	gp-bp13ue79qk8y1****
DBInstanceGroupCount	string	Number of compute groups. Note This parameter is only applicable to reserved storage mode instances.	0
ExpireTime	string	Instance expiration time (in UTC). Note The expiration time for pay-as-you-go instances is `2999-09-08T16:00:00Z`.	2999-09-08T16:00:00Z
DBInstanceNetType	string	This parameter is deprecated and will not return any value.	null
MaintainStartTime	string	Maintenance start time.	18:00Z
MaintainEndTime	string	Maintenance end time.	22:00Z
LockReason	string	This parameter is deprecated and will not return any value.	null
DBInstanceStatus	string	Instance status. For more details, see the supplementary explanation of the DBInstanceStatus parameter.	Running
RegionId	string	Region ID.	cn-hangzhou
DBInstanceDiskMBPS	long	Maximum BPS (disk throughput) of the compute group, in Mbps. Note This parameter is only applicable to reserved storage mode instances.	0
DBInstanceStorage	long	Maximum storage space of a single replica, in GB.	50
ZoneId	string	Zone ID.	cn-hangzhou-j
MaxConnections	integer	Maximum number of concurrent connections for the instance. Note This parameter is only applicable to reserved storage mode instances.	500
DBInstanceId	string	Instance ID.	gp-bp13ue79qk8y1****
DBInstanceClass	string	Instance specification. Note This parameter is only applicable to reserved storage mode instances.	gpdb.group.segsdx1
Engine	string	Database engine.	gpdb
DBInstanceCategory	string	Instance series, with the following values: Basic: Basic Edition. HighAvailability: High Availability Edition.	HighAvailability
CpuCores	integer	Number of CPU cores for the compute node, unit: Core.	2
MemorySize	long	Memory size of the compute node. Note The unit is MB for the storage reserved mode; GB for Serverless and storage elastic modes.	16
StorageSize	long	Storage space size, unit: GB.	50
SegNodeNum	integer	Number of Segment nodes. Note This parameter applies only to instances in the storage elastic mode and Serverless manual scheduling mode.	4
MasterNodeNum	integer	Number of Master nodes.	1
DBInstanceMode	string	Instance resource type, with the following values: Serverless: Serverless mode. StorageElastic: Storage elastic mode. Classic: Storage reserved mode.	StorageElastic
MinorVersion	string	Minor version of the kernel.	6.3.10.1-202207141918
SupportRestore	boolean	Indicates whether backup recovery is supported, with the following values: true: Backup recovery is supported. false: Backup recovery is not supported.	true
VSwitchId	string	vSwitch ID.	vsw-bp1cpq8mr64paltkb****
EncryptionKey	string	Encryption key. Note This parameter is returned only for instances with disk encryption enabled.	0d2470df-da7b-4786-b981-************
EncryptionType	string	Encryption type, with the following value: CloudDisk: Cloud disk encryption. Note This parameter is returned only for instances with cloud disk encryption.	CloudDisk
CoreVersion	string	Minor version number of the kernel.	mm.v6.3.10.1-202207141918
RunningTime	string	Instance running time.	4 days 22:58:55
StartTime	string	The time when the instance started running.	2022-08-11T09:26:43Z
ResourceGroupId	string	ID of the resource group where the instance is located.	rg-bp67acfmxazb4p****
ServerlessResource	integer	Compute resource threshold. Unit: ACU. Note This parameter is returned only for instances in the Serverless automatic scheduling mode.	32
IdleTime	integer	Idle release waiting time. Unit: seconds. Note This parameter is returned only for instances in the Serverless automatic scheduling mode.	600
ServerlessMode	string	The mode of the Serverless instance, with the following values: Manual: Manual scheduling. Auto: Automatic scheduling. Note This parameter is returned only for Serverless mode instances.	Auto
SegDiskPerformanceLevel	string	Performance Level (PL), currently only PL1 is supported.	PL1
VectorConfigurationStatus	string	Indicates whether vector engine optimization is enabled. The values are as follows: enabled: Indicates that vector engine optimization is enabled. disabled: Indicates that vector engine optimization is disabled.	enabled
MasterCU	integer	Master resources.	4
ProdType	string	The service type.	standard
DeployMode	string	The deployment mode.	single
StandbyZoneId	string	The secondary zone ID.	cn-hangzhou-i

DBInstanceStatus Parameter Supplement

The values of DBInstanceStatus are as follows:

Creating: Creating.
Running: In use.
Deleting: Deleting.
Rebooting: Rebooting.
DBInstanceClassChanging: Scaling up or down.
Transfering: Migrating.
EngineVersionUpgrading: Upgrading the engine version.
TransferingToOtherInstance: Transferring data to another AnalyticDB for PostgreSQL.
GuardDBInstanceCreating: Creating a disaster recovery instance.
Restoring: Restoring from a backup.
Importing: Importing data.
ImportingFromOtherInstance: Importing data from another AnalyticDB for PostgreSQL instance.
DBInstanceNetTypeChangin: Switching between public and private networks.
GuardSwitching: Disaster recovery switching.

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": "null",
        "MemoryUnit": "GB",
        "DBInstanceClassType": "x",
        "DBInstanceDescription": "gp-bp13ue79qk8y1****",
        "DBInstanceGroupCount": "0",
        "ExpireTime": "2999-09-08T16:00:00Z",
        "DBInstanceNetType": "null",
        "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,
        "ProdType": "standard",
        "DeployMode": "single",
        "StandbyZoneId": "cn-hangzhou-i"
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-10-11	The response structure of the API has changed	View Change Details
2024-01-04	The response structure of the API has changed	View Change Details
2023-08-17	The response structure of the API has changed	View Change Details
2023-05-23	The response structure of the API has changed	View Change Details