Use DescribeDBInstances to query instances - ApsaraDB RDS - Alibaba Cloud - ApsaraDB RDS

Queries a list of ApsaraDB RDS instances.

Operation description

Applicable engines

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB

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

rds:DescribeDBInstances

get

DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

rds:ResourceTag
rds:ResourceTag
rds:ResourceTag
rds:ResourceTag

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.	ETnLKlblzczshOTUbOCz****
proxyId	string	No	A deprecated parameter. You do not need to configure this parameter.	API
Engine	string	No	The database engine. Valid values: MySQL SQLServer PostgreSQL MariaDB By default, instances of all database engine types 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 states.	Running
Expired	string	No	The expiration status of the instance. Valid values:	True
SearchKey	string	No	The keyword that is used for fuzzy search by instance ID or instance description.	rm-uf6w
DBInstanceId	string	No	The instance ID.	rm-uf6wjk5****
DBInstanceType	string	No	The instance type. Valid values:	Primary
RegionId	string	Yes	The region ID. You can call DescribeRegions to query the available regions.	cn-hangzhou
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100.	30
PageNumber	integer	No	The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type.	1
InstanceNetworkType	string	No	The network type of the instance. Valid values:	Classic
VpcId	string	No	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 mode of the instance. Valid values:	Standard
Tags	string	No	The tags that are bound to the instance. Each tag consists of a TagKey and a TagValue. You can specify up to 5 tags in a single request. Format: {"key1":"value1","key2":"value2"...}. If the 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	A reserved parameter. You do not need to configure this parameter.	test
ConnectionString	string	No	The endpoint of the instance. You can use this endpoint to query the corresponding instance.	rm-uf6wjk5****.mysql.rds.aliyuncs.com
NextToken	string	No	The pagination token. Set this parameter to the value of NextToken that is returned from the last call to the DescribeDBInstances operation. If the results span multiple pages, you can use this token 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 are not available.	30
Filter	string	No	The JSON string that contains the instance filter conditions and their values.	{"babelfishEnabled":"true"}
Category	string	No	The edition of the instance. Valid values:	cluster

This operation supports the following two methods to view returned data:

Method 1: Set the MaxResults parameter to specify the number of records per page, and use the NextToken parameter to set the pagination token to display the next page. Set NextToken to the value of NextToken returned by the previous call to the DescribeDBInstances operation.

Note

When you call this operation for the first time to perform a paged query, set only MaxResults. The operation returns the first page of data and the NextToken value.

Method 2: Set the PageSize parameter to specify the number of records per page, and use the PageNumber parameter to navigate between pages.

Note

You can use only one of the preceding methods. When a large number of records are returned, Method 1 is recommended for faster query performance.

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 parameter.	0
BurstingEnabled	boolean	Indicates whether I/O burst is enabled. Valid values:	false
Category	string	The instance edition. Valid values: Basic: Basic Edition HighAvailability: High-availability Edition Finance: RDS Enterprise Edition Note This parameter is returned only when InstanceLevel is set to 1.	Basic
IsAnalyticReadOnlyIns	boolean	Indicates whether the instance is a MySQL DuckDB-based analytical instance. Valid values:	false
ConnectionMode	string	The access mode 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).	2018-11-05T11:26:02Z
DBInstanceCPU	string	The number of CPUs of the instance.	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.	4096
DBInstanceNetType	string	The network connectivity type of the instance. Valid values:	Internet
DBInstanceStatus	string	The instance status. For more information, see Instance states.	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 on which the log node resides.	dh-bp****
DedicatedHostIdForMaster	string	The ID of the host on which the master node resides.	dh-bp****
DedicatedHostIdForSlave	string	The ID of the host on which the secondary node resides.	dh-bp****
DedicatedHostNameForLog	string	The name of the host on which the log node resides.	testlog
DedicatedHostNameForMaster	string	The name of the host on which the master node resides.	testmaster
DedicatedHostNameForSlave	string	The name of the host on which the secondary node resides.	testslave
DedicatedHostZoneIdForLog	string	The zone ID of the host on which the log node resides.	cn-hangzhou-b
DedicatedHostZoneIdForMaster	string	The active zone ID of the host on which the master node resides.	cn-hangzhou-c
DedicatedHostZoneIdForSlave	string	The zone ID of the host on which the secondary node resides.	cn-hangzhou-d
DeletionProtection	boolean	Indicates whether the release protection feature is enabled. Valid values:	false
DestroyTime	string	The destruction time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2018-11-05T11:26:02Z
Engine	string	The database engine type.	MySQL
EngineVersion	string	The database engine version.	5.7
ExpireTime	string	The expiration time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC). 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 dedicated cluster general-purpose MySQL instance belongs.	TestGroup
GuardDBInstanceId	string	The ID of the disaster recovery instance. This parameter is returned if 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 combination. Valid values: true false Note A multi-zone combination refers to a zone that contains "MAZ" in its name. Example: `cn-hangzhou-MAZ10(h,i)`.	true
PayType	string	The billing method of the instance. Valid values: Postpaid: pay-as-you-go Prepaid: subscription	Postpaid
ReadOnlyDBInstanceIds	object
ReadOnlyDBInstanceId	array<object>	The list of read-only instance IDs associated with the primary instance.
	object	The read-only instance details.
DBInstanceId	string	The instance ID of the read-only instance.	rr-uf6wjk5****
RegionId	string	The region ID.	cn-hangzhou
ResourceGroupId	string	The resource group ID.	rg-acfmy****
SwitchWeight	integer	Indicates whether the ApsaraDB RDS for MySQL General-purpose instance in the dedicated cluster supports high-availability weight switching. Valid values: 100: Supported. 0: Not supported.	100
TempDBInstanceId	string	The ID of the temporary instance. This parameter is returned if the primary instance has a temporary instance.	rm-uf64zsu****
Tips	string	The exception alert information for the dedicated cluster general-purpose MySQL instance.	normal
TipsLevel	integer	The exception alert level of the ApsaraDB RDS for MySQL instance in a dedicated cluster with general-purpose specifications. Valid values: 1: Normal. 2: The specifications of the read-only instance and the primary instance are not aligned, which may affect availability. Adjust the instance specifications as needed.	1
VSwitchId	string	The vSwitch ID.	vsw-uf6adz52c2p****
VpcCloudInstanceId	string	The VPC instance ID.	rm-uf6wjk5****
VpcId	string	VPC ID。	vpc-uf6f7l4fg90****
VpcName	string	The VPC name.	test-huadong
ZoneId	string	The zone ID.	cn-hangzhou-a
BlueGreenDeploymentName	string	A reserved parameter. You do not need to configure this parameter.	test
BlueInstanceName	string	A reserved parameter. You do not need to configure this parameter.	test
GreenInstanceName	string	A reserved parameter. You do not need to configure this parameter.	test
AutoRenewal	boolean	Indicates whether auto-renewal is enabled for the instance. Valid values: true: Auto-renewal is enabled. false: Auto-renewal is not enabled. Note This parameter is returned only when PayType is set to Prepaid (subscription).	false
ColdDataEnabled	boolean	Reserved parameter.	false
IsAnalyticIns	string
NextToken	string	The pagination token. If the results are displayed on multiple pages, pass this value in the NextToken parameter in the next request to display the next page.	o7PORW5o2TJg****
PageNumber	integer	The page number. Note If you specified MaxResults or NextToken, 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 MaxResults or NextToken, this value shows only the number of records on the current page. You can ignore this value.	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": ""
      }
    ]
  },
  "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.	No credit card is available.
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.	Required parameters are missing.
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.	SSD disks do not support this operation. Upgrade to ESSD.
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 in an incorrect format or is empty.
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 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.