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
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 Resourcesis 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 |
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
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 |