View RDS instance list - API Reference| Alibaba Cloud Documentation Center

Description

Show the instance list or the instance list authorized by RAM.

Request parameters

Name	Type	Required?	Description
Action	String	Yes	Required parameter. Value: DescribeDBInstances.
RegionId	String	Yes	Instance region, viewed through the DescribeRegions function.
Engine	String	No	Database type. Value options: MySQL, SQLServer, PostgreSQL, and PPAS. If no value is specified, all types are returned.
DBInpe	String	No	Instance type. Value options: Primary: primary instance; Readonly: read-only instance; Guard: disaster recovery instance; Temp: temporary instance; If no value is specified, all types are returned.
InstanceNetworkType	String	No	VPC: VPC instance; Classic: classic instance. If no value is specified, both types are returned.
ConnectionMode	String	No	Performance: standard access mode; Safety: high security access mode. If no value is specified, both modes are returned.
PageSize	Integer	No	Number of records on each page. Value options: 30, 50, and 100. Default value: 30.
PageNumber	Integer	No	Page number, which must be greater than 0, but must not exceed the maximum Integer value. Default value: 1.

Return parameters

Name	Type	Description
<Public Return Parameters>	-	For more information, see Public parameters.
Databases	`List<Database>`	Data composed of the databases.
PageNumber	Integer	Page number.
TotalRecordCount	Integer	Total number of records.
PageRecordCount	Integer	Number of DB instances on the current page.
Items	`List<DBInstance>`	Array composed of DB instances.

DBInstance parameters

Name	Type	Description
DBInstanceId	String	Instance ID.
DBInstanceDescription	String	Instance description.
PayType	String	Billing method. Value options: Postpaid: Pay-As-You-Go; Prepaid: Subscription.
DBInstanceType	String	Primary: primary instance; ReadOnly: read-only instance; Guard: disaster recovery instance; Temp: temporary instance.
InstanceNetworkType	String	Classic: classic network; VPC: VPC network.
ConnectionMode	String	Performance: standard access mode; Safety: high security access mode.
RegionId	String	Region.
ExpireTime	String	Expiration time. Pay-As-You-Go instances never expire.
DBInstanceClass	String	For more information, see the Appendix.
Engine	String	Database type.
DBInstanceNetType	String	Internet: public network; Intranet: private network.
LockMode	String	Unlock: normal; ManualLock: locked when manually triggered; LockByExpiration: automatically locked upon expiration; LockByRestoration: automatically locked before instance rollback; LockByDiskQuota: automatically locked when the instance space is full.
LockReason	String	Reason why an instance is locked.
MasterInstanceId	String	ID of the primary instance. If this parameter is not returned (that is, if it is null), the current instance is a primary instance.
GuardDBInstanceId	String	If a disaster recovery instance is attached to the current instance, the ID of the disaster recovery instance applies.
TempDBInstanceId	String	If a temporary instance is attached to the current instance, the ID of the temporary instance applies.
ReadOnlyDBInstanceId	`List<ReadOnlyDBInstanceId>`	ID list of read-only instances attached to the primary instance.

ReadOnlyDBInstanceId parameters

Name	Type	Description
ReadOnlyDBInstanceId	String	ID of a read-only instance.

Example

Request example

https://rds.aliyuncs.com/?Action=DescribeDBInstances
&RegionId=cn-hangzhou
&Engine=MySQL
&<Public Request Parameters>

Return example

XML format:

<DescribeDBInstancesResponse>
<PageRecordCount>2</PageRecordCount>
<Items>
<DBInstance>
<DBInstanceDescription>testforRemarks</DBInstanceDescription>
<ExpireTime>2014-10-10T16:00:00Z</ExpireTime>
<DBInstanceId>rdsmjfirvmjfirv</DBInstanceId>
<DBInstanceNetType>Internet</DBInstanceNetType>
<PayType>Prepaid</PayType>
<DBInstanceStatus>Running</DBInstanceStatus>
<DBInstanceType>Primary</DBInstanceType>
<Engine>MySQL</Engine>
<LockMode>Unlock</LockMode>
<LockReason></LockReason>
<RegionId>cn-hangzhou</RegionId>
<ZoneId>cn-hangzhou-a</ZoneId>
<MasterInstanceId></MasterInstanceId>
<GuardDBInstanceId></GuardDBInstanceId>
<TempDBInstanceId></TempDBInstanceId>
<ReadOnlyDBInstanceIds>
    <ReadOnlyDBInstanceId></ReadOnlyDBInstanceId>
 </ReadOnlyDBInstanceIds> 
</DBInstance>
<DBInstance>
<DBInstanceDescription>testforcreate</DBInstanceDescription>
<ExpireTime></ExpireTime>
<DBInstanceId>rdsabqumfabqumf</DBInstanceId>
<DBInstanceNetType>Intranet</DBInstanceNetType>
<PayType>Postpaid</PayType>
<DBInstanceStatus>Running</DBInstanceStatus>
<DBInstanceType>Primary</DBInstanceType>
<Engine>MySQL</Engine>
<LockMode>Unlock</LockMode>
<LockReason></LockReason>
<RegionId>cn-hangzhou</RegionId>
<MasterInstanceId></MasterInstanceId>
<GuardDBInstanceId></GuardDBInstanceId>
<TempDBInstanceId></TempDBInstanceId>
<ReadOnlyDBInstanceIds>
     <ReadOnlyDBInstanceId></ReadOnlyDBInstanceId>
  </ReadOnlyDBInstanceIds> 
</DBInstance>
</Items>
<PageNumber>1</PageNumber>
<TotalRecordCount>2</TotalRecordCount>
<RequestId>2553A660-E4EB-4AF4-A402-8AFF70A49143</RequestId>
</DescribeDBInstancesResponse>

JSON format:

{
  "PageNumber": 1, 
  "Items": {
    "DBInstance": [
      {
        "Engine": "MySQL", 
        "DBInstanceType": "Primary", 
        "DBInstanceStatus": "Running", 
        "DBInstanceDescription": "testforRemarks", 
        "LockMode": "Unlock", 
        "RegionId": "cn-hangzhou", 
"ZoneId": "cn-hangzhou-a", 
        "DBInstanceId": "rdsmjfirvmjfirv", 
        "PayType": "Prepaid", 
        "ExpireTime": "2014-10-10T16:00:00Z", 
        "DBInstanceNetType": "Internet", 
        "LockReason": "",
        "MasterInstanceId": "",
        "GuardDBInstanceId ": "",
        "TempDBInstanceId": "",
"ReadOnlyDBInstanceIds": {
               "ReadOnlyDBInstanceId": []
              }
      }, 
      {
        "Engine": "MySQL", 
        "DBInstanceType": "Primary", 
        "DBInstanceStatus": "Running", 
        "DBInstanceDescription": "testforcreate", 
        "LockMode": "Unlock", 
        "RegionId": "cn-hangzhou", 
        "DBInstanceId": "rdsabqumfabqumf", 
        "PayType": "Postpaid", 
        "ExpireTime": "", 
        "DBInstanceNetType": "Intranet", 
        "LockReason": "",
"MasterInstanceId": "",
        "GuardDBInstanceId ": "",
        "TempDBInstanceId": "",
"ReadOnlyDBInstanceIds": {
               "ReadOnlyDBInstanceId": []
              }
      }
]
  } , 
  "TotalRecordCount": 2, 
  "PageRecordCount": 2, 
"RequestId": "2553A660-E4EB-4AF4-A402-8AFF70A49143"
}