Documentation > OpenAPI & SDK > RDS > describeDatabases



Obtain a list of all database details for the current instance

Request method


Request address


Name Type Required or not Default value Description
regionId String True Region code, with range detailed in Regions and Availability Zone Comparison Table
instanceId String True RDS instance ID, which uniquely identifies an RDS instance

Request parameter

Name Type Required or not Default value Description
dbName String False Database Name If you do not specify a database name, return all database lists
-**MySQL: This field is not supported **
- SQL Server: This field is supported
pageNumber Integer False Pages displaying data, which is 1 by default with value range: [-1,∞). When pageNumber is 1, return all data page numbers; when exceeding total pages, display the last page;
pageSize Integer False Data entries displayed on each page, which 100 by default, with the value range:[10,100], used for searching interfaces of list

Response parameter

Name Type Description
result Result


Name Type Description
databases Database[ ]
totalCount Integer


Name Type Description
dbName String Database Name, see Help Center Document: Name and Password Restrictions for specific rules
dbStatus String Database status, detailed in Enumeration Parameter Definition
- MySQL: Not support, not return this field
- SQL Server: return this field
characterSetName String Character set, detailed in Enumeration Parameter Definition
createTime String Database creation time, with the format: YYYY-MM-DD HH:mm:ss
- only support SQL Serverer
accessPrivilege DBAccessPrivilege[ ] List of Database Related Account Privilege


Name Type Description
accountName String Account Name
privilege String Privilege of account to the database with the specific definition detailed in Enumeration Parameter Definition

Response code

Return code Description
200 OK
Update Time:2019-07-11 18:54:31