Queries the list of ApsaraDB RDS instances.
Operation description
Supported engines
RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
rds:DescribeDBInstances |
get |
DBInstance
|
|
None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ClientToken |
string |
No |
The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can generate the value of this parameter on the client side. The value must be unique across different requests and can be up to 64 ASCII characters in length. The value cannot contain non-ASCII characters. |
ETnLKlblzczshOTUbOCz**** |
| proxyId |
string |
No |
[Deprecated] This parameter is deprecated and does not need to be configured. |
API |
| Engine |
string |
No |
The database engine. Valid values:
By default, instances of all database engines are returned. |
MySQL |
| ZoneId |
string |
No |
The zone ID. |
cn-hangzhou-a |
| ResourceGroupId |
string |
No |
The resource group ID. |
rg-acfmy**** |
| DBInstanceStatus |
string |
No |
The instance status. For more information, see Instance statuses. |
Running |
| Expired |
string |
No |
The expiration status of the instance. Valid values:
|
True |
| SearchKey |
string |
No |
The search key. You can perform a fuzzy search based on the instance ID or instance description. |
rm-uf6w |
| DBInstanceId |
string |
No |
The instance ID. |
rm-uf6wjk5**** |
| DBInstanceType |
string |
No |
The instance type. Valid values:
By default, instances of all types are returned. |
Primary |
| RegionId |
string |
Yes |
The region ID. You can call the DescribeRegions operation to query the region ID. |
cn-hangzhou |
| PageSize |
integer |
No |
The number of entries per page. Valid values: 1 to 100. Default value: 30. |
30 |
| PageNumber |
integer |
No |
The page number. Valid values: any integer greater than 0 and less than or equal to the maximum integer value. Default value: 1. |
1 |
| InstanceNetworkType |
string |
No |
The network type of the instance. Valid values:
By default, instances of all network types are returned. |
Classic |
| VpcId |
string |
No |
The VPC ID. |
vpc-uf6f7l4fg90**** |
| VSwitchId |
string |
No |
The vSwitch ID. |
vsw-uf6adz52c2p**** |
| DBInstanceClass |
string |
No |
The instance type. For more information, see Instance types. |
rds.mys2.small |
| EngineVersion |
string |
No |
The database engine version. |
8.0 |
| PayType |
string |
No |
The billing method. Valid values:
|
Postpaid |
| ConnectionMode |
string |
No |
The access pattern of the instance. Valid values:
By default, instances of all access patterns are returned. |
Standard |
| Tags |
string |
No |
The tags that are added to the instances you want to query, including TagKey and TagValue. You can specify up to 5 tags in a single request. Format: {"key1":"value1","key2":"value2"...}. If an instance matches any of the specified tags, the instance information is returned. |
{"key1":"value1"} |
| DedicatedHostGroupId |
string |
No |
The dedicated cluster ID. |
dhg-7a9**** |
| DedicatedHostId |
string |
No |
The host ID in the dedicated cluster. |
i-bp**** |
| InstanceLevel |
integer |
No |
Specifies whether to return the instance edition (Category) information. Valid values:
|
0 |
| QueryAutoRenewal |
boolean |
No |
This parameter is reserved and does not need to be configured. |
test |
| ConnectionString |
string |
No |
The endpoint of the instance. You can use the endpoint to query the corresponding instance. |
rm-uf6wjk5****.mysql.rds.aliyuncs.com |
| NextToken |
string |
No |
The pagination token. Set the value to the NextToken value returned from the previous call to the DescribeDBInstances operation. If the query results are paginated, you can pass this value in the next call to retrieve the next page. |
o7PORW5o2TJg**** |
| MaxResults |
integer |
No |
The number of entries per page. Valid values: 1 to 100. Default value: 30. Note
If you specify this parameter, the PageSize and PageNumber parameters become invalid. |
30 |
| Filter |
string |
No |
The JSON string of instance filter parameters and their values. |
{"babelfishEnabled":"true"} |
| Category |
string |
No |
The instance edition. Valid values:
|
cluster |
This API operation supports the following two methods for viewing returned data:
Method 1: Set the number of records per page by using the MaxResults parameter, and then set the pagination token by using the NextToken parameter to display the content of the next page. Set NextToken to the value of the NextToken parameter returned by the previous call to the DescribeDBInstances operation.
When you call the API operation for a paged query for the first time, you only need to set the MaxResults parameter. The operation returns the data of the first page and the value of the NextToken parameter.
Method 2: Set the number of records per page by using the PageSize parameter, and paginate by using the PageNumber parameter.
You can use only one of the preceding two methods. When a large number of records are returned, use Method 1 for faster query speeds.
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| Items |
object |
||
| DBInstance |
array<object> |
The list of instances. |
|
|
array<object> |
The instance details. |
||
| BpeEnabled |
string |
[Deprecated] This parameter is deprecated. |
0 |
| BurstingEnabled |
boolean |
Indicates whether I/O burst is enabled. Valid values:
|
false |
| Category |
string |
The instance edition. Valid values:
Note
This parameter is returned only when the InstanceLevel parameter is set to 1. |
Basic |
| IsAnalyticReadOnlyIns |
boolean |
Indicates whether the instance is a MySQL DuckDB analytical instance. Valid values:
|
false |
| ConnectionMode |
string |
The access pattern of the instance. Valid values:
|
Standard |
| ConnectionString |
string |
The endpoint of the instance. |
rm-uf6wjk5****.mysql.rds.aliyuncs.com |
| CreateTime |
string |
The creation time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time). |
2018-11-05T11:26:02Z |
| DBInstanceCPU |
string |
The number of CPUs for the instance. Note
This parameter is returned only when the InstanceLevel parameter is set to 1. |
2 |
| DBInstanceClass |
string |
The instance type. For more information, see Instance types. |
rds.mys2.small |
| DBInstanceDescription |
string |
The description of the instance. |
testdb |
| DBInstanceId |
string |
The instance ID. |
rm-uf6wjk5**** |
| DBInstanceMemory |
integer |
The memory size of the node. Unit: MB. Note
This parameter is returned only when the InstanceLevel parameter is set to 1. |
4096 |
| DBInstanceNetType |
string |
The network connectivity type of the instance. Valid values:
|
Internet |
| DBInstanceStatus |
string |
The instance status. For more information, see Instance statuses. |
Running |
| DBInstanceStorageType |
string |
The storage type of the instance. |
ModuleList.4.ModuleCode |
| DBInstanceType |
string |
The instance type. Valid values:
|
Primary |
| DedicatedHostGroupId |
string |
The dedicated cluster ID. |
dhg-7a9**** |
| DedicatedHostGroupName |
string |
The name of the dedicated cluster. |
testhostgroup |
| DedicatedHostIdForLog |
string |
The ID of the host where the logger node resides. |
dh-bp**** |
| DedicatedHostIdForMaster |
string |
The ID of the host where the master node resides. |
dh-bp**** |
| DedicatedHostIdForSlave |
string |
The ID of the host where the secondary node resides. |
dh-bp**** |
| DedicatedHostNameForLog |
string |
The name of the host where the logger node resides. |
testlog |
| DedicatedHostNameForMaster |
string |
The name of the host where the master node resides. |
testmaster |
| DedicatedHostNameForSlave |
string |
The name of the host where the secondary node resides. |
testslave |
| DedicatedHostZoneIdForLog |
string |
The zone ID of the host where the logger node resides. |
cn-hangzhou-b |
| DedicatedHostZoneIdForMaster |
string |
The active zone ID of the host where the master node resides. |
cn-hangzhou-c |
| DedicatedHostZoneIdForSlave |
string |
The zone ID of the host where the secondary node resides. |
cn-hangzhou-d |
| DeletionProtection |
boolean |
Indicates whether release protection is enabled for the instance. Valid values:
|
false |
| DestroyTime |
string |
The time when the instance is destroyed. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time). |
2018-11-05T11:26:02Z |
| Engine |
string |
The database engine. |
MySQL |
| EngineVersion |
string |
The database engine version. |
5.7 |
| ExpireTime |
string |
The expiration time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time). Note
Pay-as-you-go instances do not have an expiration time. |
2019-02-27T16:00:00Z |
| GeneralGroupName |
string |
The name of the group to which the general-purpose instance in the dedicated cluster belongs. |
TestGroup |
| GuardDBInstanceId |
string |
The ID of the disaster recovery instance. This parameter is returned only when the primary instance has a disaster recovery instance. |
rm-uf64zsu**** |
| InstanceNetworkType |
string |
The network type of the instance. Valid values:
|
Classic |
| IoAccelerationEnabled |
string |
Indicates whether I/O acceleration is enabled. Valid values:
|
0 |
| LockMode |
string |
The lock status of the instance. Valid values:
|
Unlock |
| LockReason |
string |
The reason why the instance is locked. |
instance_expired |
| MasterInstanceId |
string |
The ID of the primary instance. If this parameter is not returned (null), the instance is a primary instance. |
rm-uf6wjk5**** |
| MutriORsignle |
boolean |
Indicates whether the instance is deployed in a multi-zone. Valid values:
Note
A multi-zone is a zone that contains "MAZ" in its name, such as |
true |
| PayType |
string |
The billing method of the instance. Valid values:
|
Postpaid |
| ReadOnlyDBInstanceIds |
object |
||
| ReadOnlyDBInstanceId |
array<object> |
The list of read-only instance IDs. This parameter is returned only when the primary instance has read-only instances. |
|
|
object |
The read-only instance details. |
||
| DBInstanceId |
string |
The read-only instance ID. |
rr-uf6wjk5**** |
| RegionId |
string |
The region ID. |
cn-hangzhou |
| ResourceGroupId |
string |
The resource group ID. |
rg-acfmy**** |
| SwitchWeight |
integer |
Indicates whether the general-purpose instance in the dedicated cluster supports high-availability weight switching. Valid values:
|
100 |
| TempDBInstanceId |
string |
The ID of the temporary instance. This parameter is returned only when the primary instance has a temporary instance. |
rm-uf64zsu**** |
| Tips |
string |
The exception prompt message for the general-purpose instance in the dedicated cluster. |
normal |
| TipsLevel |
integer |
The exception prompt level for the general-purpose instance in the dedicated cluster. Valid values:
|
1 |
| VSwitchId |
string |
The vSwitch ID. |
vsw-uf6adz52c2p**** |
| VpcCloudInstanceId |
string |
The VPC-connected instance ID. |
rm-uf6wjk5**** |
| VpcId |
string |
The VPC ID. |
vpc-uf6f7l4fg90**** |
| VpcName |
string |
The name of the VPC. |
test-huadong |
| ZoneId |
string |
The zone ID. |
cn-hangzhou-a |
| BlueGreenDeploymentName |
string |
This parameter is reserved and does not need to be configured. |
test |
| BlueInstanceName |
string |
This parameter is reserved and does not need to be configured. |
test |
| GreenInstanceName |
string |
This parameter is reserved and does not need to be configured. |
test |
| AutoRenewal |
boolean |
Indicates whether auto-renewal is enabled for the instance. Valid values:
Note
This parameter is returned only when the PayType parameter is set to Prepaid (subscription). |
false |
| ColdDataEnabled |
boolean |
The reserved parameter. |
false |
| IsAnalyticIns |
string |
Indicates whether the instance is an analytical instance. |
false |
| NextToken |
string |
The pagination token. If the response is paginated, you can pass this value to the NextToken parameter in the next call to retrieve the next page. |
o7PORW5o2TJg**** |
| PageNumber |
integer |
The page number. Note
If you specify the MaxResults or NextToken parameter, this parameter returns only 1 and can be ignored. |
1 |
| PageRecordCount |
integer |
The number of instances on the current page. |
10 |
| RequestId |
string |
The request ID. |
1AD222E9-E606-4A42-BF6D-8A4442913CEF |
| TotalRecordCount |
integer |
The total number of records. Note
If you specify the MaxResults or NextToken parameter, this parameter returns only the number of records on the current page and can be ignored. |
100 |
Examples
Success response
JSON format
{
"Items": {
"DBInstance": [
{
"BpeEnabled": "0",
"BurstingEnabled": false,
"Category": "Basic",
"IsAnalyticReadOnlyIns": false,
"ConnectionMode": "Standard",
"ConnectionString": "rm-uf6wjk5****.mysql.rds.aliyuncs.com",
"CreateTime": "2018-11-05T11:26:02Z",
"DBInstanceCPU": "2",
"DBInstanceClass": "rds.mys2.small",
"DBInstanceDescription": "testdb",
"DBInstanceId": "rm-uf6wjk5****",
"DBInstanceMemory": 4096,
"DBInstanceNetType": "Internet",
"DBInstanceStatus": "Running",
"DBInstanceStorageType": "ModuleList.4.ModuleCode",
"DBInstanceType": "Primary",
"DedicatedHostGroupId": "dhg-7a9****",
"DedicatedHostGroupName": "testhostgroup",
"DedicatedHostIdForLog": "dh-bp****",
"DedicatedHostIdForMaster": "dh-bp****",
"DedicatedHostIdForSlave": "dh-bp****",
"DedicatedHostNameForLog": "testlog",
"DedicatedHostNameForMaster": "testmaster",
"DedicatedHostNameForSlave": "testslave",
"DedicatedHostZoneIdForLog": "cn-hangzhou-b",
"DedicatedHostZoneIdForMaster": "cn-hangzhou-c",
"DedicatedHostZoneIdForSlave": "cn-hangzhou-d",
"DeletionProtection": false,
"DestroyTime": "2018-11-05T11:26:02Z",
"Engine": "MySQL",
"EngineVersion": "5.7",
"ExpireTime": "2019-02-27T16:00:00Z",
"GeneralGroupName": "TestGroup",
"GuardDBInstanceId": "rm-uf64zsu****",
"InstanceNetworkType": "Classic",
"IoAccelerationEnabled": "0",
"LockMode": "Unlock",
"LockReason": "instance_expired",
"MasterInstanceId": "rm-uf6wjk5****",
"MutriORsignle": true,
"PayType": "Postpaid",
"ReadOnlyDBInstanceIds": {
"ReadOnlyDBInstanceId": [
{
"DBInstanceId": "rr-uf6wjk5****"
}
]
},
"RegionId": "cn-hangzhou",
"ResourceGroupId": "rg-acfmy****",
"SwitchWeight": 100,
"TempDBInstanceId": "rm-uf64zsu****",
"Tips": "normal",
"TipsLevel": 1,
"VSwitchId": "vsw-uf6adz52c2p****",
"VpcCloudInstanceId": "rm-uf6wjk5****",
"VpcId": "vpc-uf6f7l4fg90****",
"VpcName": "test-huadong",
"ZoneId": "cn-hangzhou-a",
"BlueGreenDeploymentName": "test",
"BlueInstanceName": "test",
"GreenInstanceName": "test",
"AutoRenewal": false,
"ColdDataEnabled": false,
"IsAnalyticIns": "false"
}
]
},
"NextToken": "o7PORW5o2TJg****",
"PageNumber": 1,
"PageRecordCount": 10,
"RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
"TotalRecordCount": 100
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | Invalid.NextToken | The parameter NextToken is invalid. | The specified NextToken is invalid. |
| 400 | InvalidDBInstanceType.ValueNotSupport | The specified parameter DBInstanceType is not valid. | |
| 400 | InvalidParameter.OwnerAccount | The specified parameter OwnerAccount is not valid. | The operation failed. The value of the OwnerAccount parameter is invalid. Check the value of this parameter. |
| 400 | TimeoutRetryLater | Timeout, Please retry later. | |
| 400 | InvalidExpired.Format | The instance expiration status parameter is incorrect. | The parameter that specifies the instance expiration status is invalid. |
| 400 | Abs.InvalidAccount.NotFound | account is not found. | The account does not exist. |
| 400 | Abs.ImageNotFound | The specified Image is disabled or is deleted. | The specified image has expired or has been deleted. |
| 400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | A package instance is not allowed to operate independently. |
| 400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | Pricing plan price result not found. |
| 400 | Order.NoRealNameAuthentication | You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication. | You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication. |
| 400 | InsufficientAvailableQuota | Your account quota limit is less than 0, please recharge before trying to purchase. | Your account available limit is less than 0, please recharge before trying to purchase. |
| 400 | CommodityServiceCalling.Exception | Failed to call commodity service. | Failed to call commodity service return. |
| 400 | RegionDissolvedEOM | Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support. | Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support. |
| 400 | Commodity.InvalidComponent | The module you purchased is not legal, please buy it again. | The module you purchased is not legal, please buy it again. |
| 400 | RegionEndTimeDissolvedAustralia | Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. | Hello customer, this area has been abolished. |
| 400 | Price.CommoditySys | Commodity system call exception. | Commodity system call exception. |
| 400 | Pay.InsufficientBalance | Insufficient available balance. | Insufficient available balance. |
| 400 | Order.PeriodInvalid | There is a problem with the period you selected, please choose again. | There is a problem with the period you selected, please choose again. |
| 400 | pay.noCreditCard | Account not bound to credit card. | The account is not bound to a credit card. |
| 400 | Order.InstHasUnpaidOrder | There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. | There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. |
| 400 | noAvailablePaymentMethod | No payment method is specified for your account. We recommend that you add a payment method. | No payment method has been specified for your account. We recommend that you add a payment method. |
| 400 | BasicInfoUncompleted | Your information is incomplete. Complete your information before the operation. | Your basic information is not complete, please complete your basic information before operation. |
| 400 | Risk.RiskControlRejection | Your account is abnormal, please contact customer service for details. | Your account is abnormal, please contact customer service for details. |
| 400 | Api.NotSupport | Specified api is not supported. | The current interface does not support. |
| 400 | ContainForbiddenLabelError | There is a label that prohibits placing orders. Please contact your distributor for assistance. | You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor. |
| 400 | InvalidDBInstanceId.NotFound | The DBInstanceId provided does not exist in records. | The DBInstanceId provided does not exist. |
| 400 | InvalidInstanceLevel.DiskType | Specified instance level not support request disk type | The current instance type does not support the specified storage type. |
| 400 | InvalidParam | Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. | The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica. |
| 400 | KmsApiError | User secret key invalid. | The user key is invalid. |
| 400 | System.SaleValidateFailed | Sales expression validation system error. | A system error occurs when the sales expression is verified. |
| 400 | SqlExecuteFailedOrTimeout | sql command execution failed or timed out:%s. | SQL command execution failed or timed out |
| 400 | ColdData.EngineVersionNotSupport | The current instance engine version not support coldDataEnabled. | The current instance engine version not support coldDataEnabled. |
| 400 | ColdData.MinorVersionNotSupport | The current instance minor version not support coldDataEnabled. | The current instance minor version not support coldDataEnabled. |
| 400 | IncorrectTargetClasscode | The current instance type does not support this operation. | This operation is not supported by the instance type. |
| 400 | InvalidConnectionString.Duplicate | Specified connection string already exists in the RDS. | The link address name is duplicate. Please reset the connection string. |
| 400 | RequiredParam.NotFound | Required input param is not found. | The required parameters are not provided. |
| 400 | Parameters.Invalid | Parameter error, please check the parameters. | Parameter error, please check the parameters. |
| 400 | BackupPolicyNotSupport | Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. | Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. |
| 400 | InvalideStatus.Format | The instance status does not support this operation. | The instance status does not support this operation. |
| 400 | InvalidReleasedKeepPolicy.Format | Specified Released Keep Policy is not valid. | Specified Released Keep Policy is not valid. |
| 400 | InvalidDBInstanceEngineType.Format | the DB instance engine type does not support this operation. | This operation is not supported for the database engine of the instance. |
| 400 | Pay.NoCreditCard | No credit cards. | No credit cards. |
| 400 | VpcNetworkTypeNotSupport | The vpc network type instance does not support this operation. | The vpc network type instance does not support this operation. |
| 400 | MirrorInsExists | Specified DB instance mirror ins already existed. | Specified DB instance mirror ins already existed. |
| 400 | UnsupportedClassCode | The specified DB instance class stops selling. | The specified DB instance class stops selling. |
| 400 | InvalidBackupSet | The specified database does not exist in the backup set. | The specified database does not exist in the backup set. |
| 400 | OrdTCommodityQueryError | Failed to query for product. | Failed to query product. |
| 400 | ProductInstanceReleased | The instance has been released. Please check before placing the order. | The instance has been released, please verify and place an order. |
| 400 | RegionEndTimeDissolvedIndia | The region is no longer supported. | The region is no longer supported. |
| 500 | ExternalFailure | The request processing has failed due to external service failure. | The request processing has failed due to external service failure. |
| 500 | RequestMetaDataFailed | The service request failed. Please try again later or contact service personnel. | The service request failed. Please try again later or contact service personnel. |
| 500 | InvokeProxyFailure | The request processing has failed due to service failure of rds api. | The request failed to be processed due to an RDS API failure. |
| 403 | OrderStatus.UnPaid | The specified db instance has unpaid order. | The instance has an unpaid order. Please pay first and try again. |
| 403 | InvalidReduceDiskSize | The storage capacity after the scale-down must be larger than the used amount. | The scale-in target capacity cannot be less than the current storage space usage |
| 403 | CloudSSDNotSupport | Cloud ssd does not support this operation, please upgrade to essd. | This operation is not supported for standard SSDs. Upgrade to ESSDs. |
| 403 | InvalidUserOperatorPermission | The user permission does not support this operation. | The user is not authorized to perform this operation. |
| 403 | InvalidVswitchId | Specified conn vswitch id is not valid. | The specified VSwitchId is empty or in an invalid format. |
| 403 | IncorrectMinorVersion | Current engine minor version does not support operations. | This operation is not supported for the current minor engine version. |
| 403 | OperationDenied.ZoneResource | There is no available zone for inventory. | There is no available zone for inventory. |
| 403 | NotInFlowController | Sorry,no permission. | Sorry,no permission. |
| 403 | InvalidKmsKey | Kms key is disabled. | The specified KMS key is disabled. |
| 403 | InvalidInstanceLevel.Malformed | Current DB instance level does not support this operation. | The specified database instance type does not support this operation. |
| 404 | InvalidClusterKms | The current instance does not authorized to access the Key Management Service. | The instance does not have permissions to access Key Management Service (KMS). |
| 404 | Request.NotFound | The requested resource is not available. | The requested resources are unavailable. |
| 404 | HostInfo.NotFound | The specified host info is not found. | The specified host information does not exist. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.