更新时间:2025-08-04 GMT+08:00

查询数据库用户列表

功能介绍

在指定实例中查询数据库用户列表。

接口约束

  • 实例在创建、变更规格、修改端口、异常或冻结状态下不能执行该操作。
  • 除RDS界面和API以外的其他方式创建的数据库和账号,如果创建的数据库名和账号名不满足数据库命名规则(参见表2)和账号命名规则(参见表2),例如包含中文或不支持的特殊字符,那么该数据库和账号不支持RDS界面或API的数据库管理和账号管理功能。
  • 如果源库的数据库名和账号名不满足数据库命名规则(参见表2)和账号命名规则(参见表2),迁移到目标库RDS for MySQL后,该数据库和账号也不支持RDS界面或API的数据库管理和账号管理功能。

URI

  • URI格式

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

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    参数解释

    租户在某一Region下的项目ID。

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

    约束限制

    不涉及。

    取值范围

    不涉及。

    默认取值

    不涉及。

    instance_id

    参数解释

    实例ID。

    约束限制

    不涉及。

    取值范围

    不涉及。

    默认取值

    不涉及。

    page

    参数解释

    分页页码。

    约束限制

    不涉及。

    取值范围

    从1开始。

    默认取值

    不涉及。

    limit

    参数解释

    每页数据条数。

    约束限制

    不涉及。

    取值范围

    [1, 100]

    默认取值

    不涉及。

请求消息

  • 请求参数

    无。

  • URI样例

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

响应消息

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

    名称

    参数类型

    说明

    users

    Array of objects

    参数解释

    列表中每个元素表示一个数据库用户。

    详情请参见表3

    total_count

    Integer

    参数解释

    数据库用户总数。

    取值范围

    不涉及。

    表3 users元素结构说明

    名称

    参数类型

    说明

    name

    String

    参数解释

    账号名。

    取值范围

    不涉及。

    attributes

    Object

    参数解释

    用户的权限属性。

    详情请参见表4

    memberof

    Array of strings

    参数解释

    用户的默认权限。

    取值范围

    不涉及。

    表4 attributes 元素结构说明

    名称

    参数类型

    说明

    rolsuper

    Boolean

    参数解释

    用户是否具有超级用户权限。

    取值范围

    false:不具有超级用户权限。

    rolinherit

    Boolean

    参数解释

    用户是否自动继承其所属角色的权限。

    取值范围

    • true:自动继承其所属角色的权限。
    • false:不自动继承其所属角色的权限。

    rolcreaterole

    Boolean

    参数解释

    用户是否支持创建其他子用户。

    取值范围

    • true:支持创建其他子用户。
    • false:不支持创建其他子用户。

    rolcreatedb

    Boolean

    参数解释

    用户是否可以创建数据库。

    取值范围

    • true:支持创建数据库。
    • false:不支持创建数据库。

    rolcanlogin

    Boolean

    参数解释

    用户是否可以登录数据库。

    取值范围

    • true:支持登录数据库。
    • false:不支持登录数据库。

    rolconnlimit

    Integer

    参数解释

    用户连接实例的最大并发连接数。-1表示没有限制。

    取值范围

    不涉及。

    rolreplication

    Boolean

    参数解释

    用户是否属于复制角色。

    取值范围

    • true:属于复制角色。
    • false:不属于复制角色。

    rolbypassrls

    Boolean

    参数解释

    用户是否绕过每个行级安全策略。

    取值范围

    • true:绕过每个行级安全策略。
    • false:不绕过每个行级安全策略。
  • 正常响应样例
    {
    "users": [
    {
      "name": "rdsuser",
      "attributes": {
        "rolsuper": false,
        "rolinherit": true,
        "rolcreaterole": true,
        "rolcreatedb": true,
        "rolcanlogin": true,
        "rolconnlimit": -1,
        "rolreplication": true,
        "rolbypassrls": false
       },
      "memberof": ["pg_monitor", "pg_read_all_stats", "pg_stat_scan_tables", "pg_signal_backend"]
    }, 
    {
      "name": "rdsuser1",
      "attributes": {
        "rolsuper": false,
        "rolinherit": true,
        "rolcreaterole": true,
        "rolcreatedb": true,
        "rolcanlogin": true,
        "rolconnlimit": -1,
        "rolreplication": true,
        "rolbypassrls": false
    },
      "memberof": []
    }],
    "total_count": 2
    }

状态码

错误码

请参见错误码