文档中心

云数据库 MySQL 版

账号管理

DescribeDBAccounts - 查看账号列表

DescribeDBAccounts - 查看账号列表

调用 DescribeDBAccounts 接口查看账号列表。

请求类型

同步请求。

调试

API Explorer

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

请求参数

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

返回参数

参数	类型	示例值	描述
Accounts	Array of AccountObject	请参见返回示例。	账号列表。
Total	Integer	1	账号列表总数。

AccountObject

参数	类型	示例值	描述
AccountDesc	String	这是一段账号的描述信息。	账号的描述信息。说明如果账号没有描述信息，则不会返回该字段。
AccountName	String	test1	账号名称。
AccountPrivileges	Array of AccountPrivilegeObject	null	账号在指定数据库的权限信息。说明如果账号没有指定数据库的权限，该字段的返回值为 null。
AccountPrivilegesSQL	Array of String	[ "GRANT PROCESS, REPLICATION SLAVE, REPLICATION CLIENT ON . TO 'TestAccount'@'%'", "GRANT SELECT, SHOW VIEW ON mysql.* TO 'TestAccount'@'%'" ]	为账号进行当前权限设定对应的 SQL 语句。
AccountStatus	String	Available	账号状态，取值为： Unavailable：不可用。 Available：可用。
AccountType	String	Normal	账号类型，取值范围： Super：高权限账号。 Normal：普通账号。
AuthenticationType	String	IAM	数据库账号的鉴权类型。取值： MySQLNative：MySQL 本地认证。 IAM：IAM 认证。说明该参数作为请求参数时，默认值为 MySQLNative。仅支持在创建账号时为账号指定鉴权类型，创建账号后则不支持修改。指定数据库账号的鉴权类型目前为加白功能，如需使用，请提交工单申请。
GlobalAccountPrivileges	Array of String	[ "PROCESS", "REPLICATION SLAVE", "REPLICATION CLIENT" ]	账号的全局权限。该字段的取值范围如下（可多选）： - PROCESS - REPLICATION SLAVE - REPLICATION CLIENT - SELECT - INSERT - UPDATE - DELETE - CREATE - DROP - RELOAD - REFERENCES - INDEX - ALTER - LOCK TABLES - EXECUTE - CREATE VIEW - SHOW VIEW - CREATE ROUTINE - ALTER ROUTINE - CREATE USER - EVENT - TRIGGER - SHOW DATABASES - CREATE TEMPORARY TABLES
HasTableColumnPrivilegeDBNames	Array of String	["db1","db2"]	账号拥有的表列权限所属的数据库。说明如果账号没有表列权限，则不返回该字段。
Host	String	%	指定的数据库账号可以访问数据库的 IP 地址。

AccountPrivilegeObject

参数	类型	示例值	描述
AccountPrivilege	String	ReadWrite	数据库权限的类型。取值范围： ReadWrite：读写权限。 ReadOnly：只读权限。 DDLOnly：仅 DDL 权限。 DMLOnly：仅 DML 权限。 Custom：自定义权限。 Global：全局权限。 None：清除账号权限。说明该参数作为请求参数时，有以下注意事项：仅支持在作为请求参数时允许取值为 Global 和 None。权限类型为单选，传多个时会报错。仅 GrantDBAccountPrivilege 接口支持为 AccountPrivilege 取值 None。当 AccountPrivilege 取值 None 时，如果 DBName 的取值为空字符串，则清除账号的所有全局权限。如果 DBName 的取值为指定数据库，则清除账号在该数据库的所有权限。
AccountPrivilegeDetail	String	SELECT,INSERT,UPDATE	账号的权限信息。取值范围如下： - SELECT - INSERT - UPDATE - DELETE - CREATE - DROP - REFERENCES - INDEX - ALTER - CREATE TEMPORARY TABLES - LOCK TABLES - EXECUTE - CREATE VIEW - SHOW VIEW - EVENT - TRIGGER - CREATE ROUTINE - ALTER ROUTINE 说明作为请求参数时，在 AccountPrivilege 取值为 Custom 时必填。在 CreateDBAccount 接口中，会自动为账号赋予 REPLICATION SLAVE、PROCESS 和 REPLICATION CLIENT 全局权限。可取多个值。使用英文逗号（,）分隔多个权限。写入方式为覆盖方式。
DBName	String	testdb1	需修改账号授权的或账号已有权限的数据库名称。说明在 CreateDBAccount 和 GrantDBAccountPrivilege 接口中作为请求参数时，需确认 DBName 对应的数据库已存在。进行全局授权的修改时，应为 DBName 传空字符。

示例

请求示例

返回示例

错误码

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

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

这个页面对您有帮助吗？

有用

有用

无用

无用