本文导读

接口说明
约束说明
调试
URI
请求消息
响应消息
SDK
状态码
错误码

展开导读

文档首页/ 文档数据库服务 DDS/ API参考/ API v3（推荐）/ 管理数据库和用户/ 查询数据库角色列表

查询数据库角色列表

更新时间：2023-11-08 GMT+08:00

查看PDF

接口说明

查询数据库角色列表。

约束说明

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

调试

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

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}
URI样例
- 查询数据库角色列表：
  https://dds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/3527b6b16e7639b88930a360d2c4in02/db-roles
- 根据指定条件查询角色列表
   https://dds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/3527b6b16e7639b88930a360d2c4in02/db-roles?role_name=testRole&db_name=testDb&offset=0&limit=100

表1 参数说明
名称	参数类型	是否必选	描述
X-Auth-Token	String	是	从IAM服务获取的用户Token。请参考认证鉴权。
project_id	String	是	租户在某一Region下的项目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 参数说明
名称	参数类型	是否必选	描述
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\"}]"
}

SDK

单击文档数据库服务 DDS SDK，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码。

错误码

详情请参见错误码。

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

上一篇：查询数据库用户列表

下一篇：修改数据库用户密码

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

盘古Doer提问云社区提问