Queries a list of AnalyticDB for PostgreSQL instances.
Operation description
You can call this operation to query the instance types, network types, and states of AnalyticDB for PostgreSQL instances within a region.
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
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:DescribeDBInstances | get |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID. Note
You can call the DescribeRegions operation to query the most recent region list.
| cn-hangzhou |
| DBInstanceDescription | string | No | The description of the instance. | gp-bp12ga6v69h86**** |
| InstanceNetworkType | string | No | The network type of the instance. Valid values:
Note
If you do not specify this parameter, instances of all network types are returned.
| VPC |
| DBInstanceIds | string | No | The instance ID. Separate multiple values with commas (,). | gp-bp12ga6v69h86**** |
| PageSize | integer | No | The number of entries per page. Valid values:
Default value: 30. | 50 |
| PageNumber | integer | No | The page number. Pages start from page 1. Default value: 1. | 1 |
| Tag | array<object> | No | The tags. | |
| object | No | |||
| Key | string | No | The key of tag N. | test-key |
| Value | string | No | The value of tag N. | test-value |
| InstanceDeployTypes | array | No | This parameter is no longer used. | |
| string | No | This parameter is no longer used. | null | |
| DBInstanceStatuses | array | No | The state of the instance. | |
| string | No | The state of the instance. Separate multiple values with commas (,). For more information, see Instance statuses. Note
You must specify this parameter in lowercase letters.
| running | |
| DBInstanceCategories | array | No | The edition of the instance. Separate multiple values with commas (,). | |
| string | No | The edition of the instance. Separate multiple values with commas (,). Valid values:
| basic,highavailability | |
| DBInstanceModes | array | No | The resource type of the instance. Separate multiple values with commas (,). | |
| string | No | The resource type of the instance. Separate multiple values with commas (,). Valid values:
| storageelastic,serverless | |
| ResourceGroupId | string | No | The ID of the resource group to which the instance belongs. | rg-bp67acfmxazb4p**** |
| VpcId | string | No | The VPC ID. You can use this parameter to filter instances that reside in the specified VPC. | vpc-t4nqyp3tc5mx7vy6**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"TotalRecordCount": 1,
"PageRecordCount": 1,
"RequestId": "53EA07B7-FC2A-521B-AB7C-27**********",
"PageNumber": 1,
"Items": {
"DBInstance": [
{
"VpcId": "vpc-bp19ame5m1r3oejns****",
"ExpireTime": "2999-09-08T16:00:00Z",
"DBInstanceNetType": "2",
"InstanceDeployType": "cluster",
"StorageType": "cloud_essd",
"CreateTime": "2021-10-09T04:54:08Z",
"PayType": "Postpaid",
"Tags": {
"Tag": [
{
"Key": "test-key",
"Value": "test-value"
}
]
},
"LockReason": "0",
"DBInstanceStatus": "Running",
"ConnectionMode": "null",
"LockMode": "Unlock",
"EngineVersion": "6.0",
"RegionId": "cn-hangzhou",
"VSwitchId": "vsw-bp1cpq8mr64paltkb****",
"InstanceNetworkType": "VPC",
"ZoneId": "cn-hangzhou-h",
"DBInstanceId": "gp-bp12ga6v69h86****",
"Engine": "gpdb",
"DBInstanceDescription": "gp-bp12ga6v69h86****",
"SegNodeNum": "4",
"StorageSize": "50",
"MasterNodeNum": 1,
"DBInstanceCategory": "HighAvailability",
"DBInstanceMode": "StorageElastic",
"ResourceGroupId": "rg-bp67acfmxazb4p****",
"ServerlessMode": "Manual",
"ProdType": "standard"
}
]
}
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-01-04 | The response structure of the API has changed | View Change Details |
| 2023-12-11 | The request parameters of the API has changed | View Change Details |