文档首页/云数据库 RDS/API参考/API v3（推荐）/管理数据库和用户（MySQL）/查询数据库用户列表 - ListDbUsers
更新时间：2026-02-04 GMT+08:00
查看PDF
分享

查询数据库用户列表 - ListDbUsers

功能介绍

查询指定实例中的数据库用户。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:databaseUser:list

list

instance

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

-

-

接口约束

  • 实例在异常或冻结状态下不能执行该操作。
  • 不支持查询只读实例的数据库用户列表。

URI

  • URI格式

    GET /v3/{project_id}/instances/{instance_id}/db_user/detail?page={page}&limit={limit}

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    参数解释：

    租户在某一region下的project ID。

    约束限制：

    非空。

    取值范围：

    获取方法请参见获取项目ID。

    默认取值：

    不涉及。

    instance_id

    是

    参数解释：

    实例ID。

    约束限制：

    非空。

    取值范围：

    该参数值可调用查询数据库实例列表接口，通过表4中的“id”获取。

    默认取值：

    不涉及。

    page

    是

    参数解释：

    分页页码，从1开始。

    约束限制：

    不涉及。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

    limit

    是

    参数解释：

    每页数据条数。

    约束限制：

    不涉及。

    取值范围：

    [1, 100]

    默认取值：

    不涉及。

请求消息

  • 请求参数

    无。

  • URI样例

    GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/db_user/detail?page=1&limit=10

响应消息

  • 正常响应要素说明
    表2 要素说明

    名称

    参数类型

    说明

    users

    Array of objects

    参数解释：

    数据库账号信息列表。

    详情请参见表3。

    total_count

    Integer

    参数解释：

    数据库账号个数。

    取值范围：

    不涉及。

    表3 users元素结构说明

    名称

    参数类型

    说明

    name

    String

    参数解释：

    账号名。

    取值范围：

    不涉及。

    comment

    String

    参数解释：

    账号备注。目前仅支持MySQL 8.0.25及以上版本。

    取值范围：

    不涉及。

    databases

    Array of objects

    参数解释：

    账号已授权的数据库。

    详情请参见表4。

    hosts

    Array of strings

    参数解释：

    账号配置的host信息。

    取值范围：

    • 若IP地址为%，表示允许所有地址访问MySQL实例。
    • 若IP地址为“10.10.10.%”，表示10.10.10.X的IP地址都可以访问MySQL实例。
    • 支持添加多个IP地址。
    表4 databases元素结构说明

    参数

    参数类型

    描述

    name

    String

    参数解释：

    数据库名称。

    取值范围：

    不涉及。

    readonly

    Boolean

    参数解释：

    授权模式，是否只读。

    取值范围：

    • true表示只读。
    • false表示可读写。
  • 正常响应样例 
    {
    "users": [
        {
            "name": "aaa",
            "comment": "user comment",
            "databases": [
                {
                    "name": "db1",
                    "readonly": false
                }
            ],
            "hosts": [
                "10.%"
            ]
        }
    ],
    "total_count": 1
}

状态码

错误码

请参见错误码。