文档首页/文档数据库服务 DDS/API参考（联盟区域）/API v3（推荐）/管理数据库和用户/查询数据库角色列表
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

查询数据库角色列表

接口说明

查询数据库角色列表。

约束说明

  • 该接口支持DDS社区版。
  • 实例在创建、规格变更、修改端口、重启等过程中以及状态为非“normal”时，不允许执行该操作。

URI

  • URI格式

    GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-roles?role_name={role_name}&db_name={db_name}&offset={offset}&limit={limit}

表1 参数说明

名称

参数类型

是否必选

描述

project_id

String

是

租户在某一region下的project ID。请参考获取项目ID章节获取项目编号。

instance_id

String

是

实例ID，可以调用“查询实例列表”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

role_name

String

否

角色名称。

取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、中划线、下划线和点。

db_name

String

否

数据库名称，默认为“admin”。

取值范围：长度为1~64位，可以包含大写字母（A~Z）、小写字母（a~z）、数字（0~9）、下划线。

offset

Integer

否

索引位置偏移量。

取值大于或等于0。不传该参数时，查询偏移量默认为0。

limit

Integer

否

查询个数上限值。

取值范围：1~100。不传该参数时，默认查询前100条实例信息。

请求参数

表2 请求Header参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

用户Token。

响应参数

表3 参数说明

名称

参数类型

是否必选

描述

roles

String

是

数据库角色信息。

注意：

返回格式按照数据库原生格式返回，需要用户解析。

total_count

Integer

是

数据库角色总数。

  • 响应示例 
    {
  "total_count": 1,
  "roles": "[{\"privileges\":[{\"resource\":{\"collection\":\"\",\"db\":\"admin\"},\"actions\":[\"viewUser\"]}],\"inheritedPrivileges\":[{\"resource\":{\"collection\":\"\",\"db\":\"admin\"},\"actions\":[\"viewUser\"]}],\"role\":\"userAdmin\",\"roles\":[],\"inheritedRoles\":[],\"isBuiltin\":true,\"db\":\"admin\"}]"
}

状态码

详情请参见状态码。

错误码

详情请参见错误码。