功能介绍

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

调用接口前，您需要了解API 认证鉴权。
调用接口前，您需要提前获取到地区和终端节点，即下文中的Endpoint值。

调试

您可以在API Explorer中调试该接口。

URI

URI格式

GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-users

URI样例

https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/instances/{instance_id}/db-users

参数说明

表1 参数说明

参数	是否必选	参数类型	描述
project_id	是	String	租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。
instance_id	是	String	实例ID。
offset	否	Integer	分页符。从第一条数据偏移offset页数据后开始查询，默认为0（偏移0页数据，表示从第一条数据开始查询），必须为数字，不能为负数。例如：该参数指定为1，limit指定为10，则只展示第11-20条数据。
limit	否	Integer	每页显示的条目数量,取值范围[1, 100]，默认10。

请求消息

无。

响应消息

正常响应要素说明

表2 参数说明

参数	参数类型	描述
users	Array of objects	列表中每个元素表示一个数据库用户，详情参见表3。
total_count	Integer	数据库用户总数。

表3 users字段数据结构说明

参数	参数类型	描述
name	String	数据库名称。
attributes	Object	用户的权限属性，详情参见表4。
memberof	String	用户的默认权限。

表4 attributes字段数据结构说明

参数	参数类型	描述
rolsuper	Boolean	用户是否具有管理员权限，取值为“true”或“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": "root",
            "attributes": {
                "rolsuper": false,
                "rolinherit": true,
                "rolcreaterole": true,
                "rolcreatedb": true,
                "rolcanlogin": true,
                "rolconnlimit": -1,
                "rolreplication": false,
                "rolbypassrls": false
            },
            "memberof": "{gs_role_copy_files,gs_role_signal_backend,gs_role_tablespace,gs_role_replication,gs_role_account_lock}"
        }
    ],
    "total_count": 1
}

异常响应

请参见异常请求结果。

状态码

正常

200

异常

请参见状态码。

错误码

请参见错误码。

父主题： 管理数据库和用户

同意关联代理商云淘科技，购买华为云产品更优惠（QQ 78315851）

内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家