功能介绍

查询数据库角色列表。

接口约束

• 该接口支持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

• 参数说明

  名称	是否必选	参数类型	描述
  project_id	是	String	租户在某一region下的project 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条实例信息。

请求消息

无。

响应消息

• 要素说明

  表1 要素说明

  名称	参数类型	描述
  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\"}]"
  }

状态码

详情请参见状态码。

错误码

详情请参见错误码。