文档中心

云数据库 MySQL 版

数据库管理

DescribeDatabases - 查看数据库列表

DescribeDatabases - 查看数据库列表

调用 DescribeDatabases 接口查看数据库列表。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mysql-r3xq0zdl****	实例 ID。
DBName	String	否	testdb1	数据库名称。
PageNumber	Integer	否	1	当前页页码。取值最小为 1。默认值为 1。
PageSize	Integer	否	10	每页记录数。最小值为 1，最大值不超过 1000。默认值为 10。

返回参数

参数	类型	示例值	描述
Total	Integer	1	数据库总数。
Databases	Array of DatabaseObject	[ { "CharacterSetName": "utf8", "DBDesc": "这是一段数据库 testdb1 的描述。", "DBName": "testdb1", "DBPartition": 0, "DBStatus": "Available", "DatabasePrivileges": null, "DatabasePrivilegesInfo": null } ]	数据库列表。

DatabaseObject

参数	类型	示例值	描述
DBName	String	db1	数据库名。
CharacterSetName	String	utf8mb4	数据库字符集。
DBDesc	String	这是一段数据库的描述信息。	数据库的描述信息。如果数据库没有描述信息，该字段为空。
DBStatus	String	Available	数据库状态。取值为： Unavailable：不可用。 Available：可用。
DatabasePrivileges	Array of DatabasePrivilegeObject	[ { "AccountName": "user1", "AccountPrivilege":"ReadWrite" } ]	数据库账号权限列表。

DatabasePrivilegeObject

参数	类型	示例值	描述
AccountName	String	testdb1	需授权的账号名称。
Host	String	%	指定的数据库账号可以访问数据库的 IP 地址。默认值为 %。若指定 Host 为 %，允许该账号从任意 IP 地址访问数据库。若指定 Host 为 192.10.10.%，则表示该账号可从 192.10.10.0~192.10.10.255 之间的 IP 地址访问数据库。指定的 Host 需要添加在实例所绑定的白名单中，
AccountPrivilege	String	ReadWrite	授予的账号权限类型，取值： ReadWrite：读写权限。 ReadOnly：只读权限。 DDLOnly：仅 DDL 权限。 DMLOnly：仅 DML 权限。 Custom：自定义权限。说明权限类型单选，传多个权限时报错。
AccountPrivilegeDetail	String	SELECT,INSERT,UPDATE	数据库权限字符串。作为请求参数时，当 AccountPrivilege 取值为 Custom 时必填，取值： SELECT INSERT UPDATE DELETE CREATE DROP REFERENCES INDEX ALTER CREATE TEMPORARY TABLES LOCK TABLES EXECUTE CREATE VIEW SHOW VIEW CREATE ROUTINE ALTER ROUTINE EVENT TRIGGER 作为返回结果时，不管 AccountPrivilege 的值是否为 Custom，都会展示 AccountPrivilege 的详细权限。说明多个字符串使用英文逗号（,）分隔。

示例

请求示例

返回示例

错误码

更多详情，请参见错误码。

最近更新时间：2026.04.09 11:58:29

这个页面对您有帮助吗？

有用

有用

无用

无用