文档首页/ 数据仓库服务 DWS/ 更多文档/ API参考（阿布扎比区域）/ API说明/ 数据库权限管理/ 查询所有数据库用户/角色
更新时间：2025-09-23 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询所有数据库用户/角色

功能介绍

查询所有数据库用户/角色。

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/clusters/{cluster_id}/db-manager/users

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

cluster_id

是

String

参数解释：

集群ID。获取方法请参见获取集群ID。

约束限制：

必须是有效的dws集群ID。

取值范围：

36位UUID。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释：

分页偏移量，从0开始，页数减1。

约束限制：

不涉及。

取值范围：

大于等于0。

默认取值：

0

limit

否

Integer

参数解释：

分页单页大小。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

1000。

type

否

String

参数解释：

查询角色还是用户。

约束限制：

不涉及。

取值范围：

ROLE：表示查询所有角色。

USER：表示查询所有用户。

默认取值：

不涉及。

user_type

否

String

参数解释：

用户类型，COMMON、IAM或者OneAccess。

约束限制：

不涉及。

取值范围：

COMMON：表示普通数据库用户。

IAM：表示IAM同步的数据库用户。

OneAccess: 表示OneAccess用户。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

users

Array of DatabaseUser objects

参数解释：

用户/角色列表。

取值范围：

不涉及。
表4 DatabaseUser

参数

参数类型

描述

name

String

参数解释：

用户名。

取值范围：

不涉及。

login

Boolean

参数解释：

是否可以登录。

取值范围：

不涉及。

user_type

String

参数解释：

用户类型。

取值范围：

COMMON：表示普通数据库用户。

IAM：表示IAM同步的数据库用户。

OneAccess: 表示OneAccess用户。

请求示例

查询所有用户。

GET https://{Endpoint}/v1/0536cdee2200d5912f7cc00b877980f1/clusters/a89aea88-7ea2-40bd-8ac8-8b93e169e5d6/db-manager/users

响应示例

状态码：200

查询成功。

{
  "users" : [ {
    "name" : "user1",
    "login" : true,
    "user_type" : "COMMON"
  }, {
    "name" : "user2",
    "login" : false,
    "user_type" : "IAM"
  } ]
}

状态码

状态码

描述

200

查询成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。
父主题： 数据库权限管理