文档

DescribeTenantUsers - 查询租户账号列表

更新时间:

查询一个租户下所有数据库访问的账号列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
oceanbase:DescribeTenantUsersRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
TenantIdstring

租户 ID。

ob2mr3oae0****
SearchKeystring

模糊查询列表的筛选关键字。

pay
PageNumberinteger

分页查询的页码。 起始值:1,默认值:1。

1
PageSizeinteger

分页查询时设置的每页行数。 最大值:100,默认值:10。

10
UserNamestring

数据库账号名称。 不能使用某些预留关键字,如 SYS、root 等。

pay_test

返回参数

名称类型描述示例值
object

请求的返回结果。

TotalCountinteger

租户中的数据库账号总数。

1
RequestIdstring

请求 ID。

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
TenantUsersobject []

租户中的数据库账号列表信息。

UserTypestring

数据库账号类型。

  • Admin:超级账户。
  • Normal:普通账户。
Normal
Descriptionstring

数据库账号的描述信息。

use for test
Databasesobject []

账号具备的数据库权限列表信息。

Databasestring

数据库(schema)名称

db_pay1
Rolestring

拥有的角色。
对于 Oracle 模式,角色为 schema 级别,其可分为

  • ReadWrite:读写权限,包括 CREATE TABLE CREATE VIEW CREATE PROCEDURE CREATE SYNONYM CREATE SEQUENCE CREATE TRIGGER CREATE TYPE CREATE SESSION EXECUTE ANY PROCEDURE CREATE ANY OUTLINE ALTER ANY OUTLINE DROP ANY OUTLINE CREATE ANY PROCEDURE ALTER ANY PROCEDURE DROP ANY PROCEDURE CREATE ANY SEQUENCE ALTER ANY SEQUENCE DROP ANY SEQUENCE CREATE ANY TYPE ALTER ANY TYPE DROP ANY TYPE SYSKM CREATE ANY TRIGGER ALTER ANY TRIGGER DROP ANY TRIGGER CREATE PROFILE ALTER PROFILE DROP PROFILE;
  • ReadOnly:只读权限,SELECT 对于 MySQL 模式,角色为数据库(Database)级别,其有以下几类:
  • ReadWrite:读写权限,包括 ALL PRIVILEGES;
  • ReadOnly:只读权限,包括 SELECT;
  • DDL: DDL 权限,包括 CREATE,DROP,ALTER,SHOW VIEW,CREATE VIEW;
  • DML: DML 权限,包括 SELECT,INSERT,UPDATE,DELETE,SHOW VIEW。
说明
另外, Oracle 账户对自己的 Schema 有默认的读写权限,此处不会列出。
ReadOnly
Tablestring

表的名称。

tbl_pay1
Privilegesstring

用户授予数据库自定义权限时,privileges 返回自定义的权限内容,以逗号 "," 分割;其余时间 privileges 不返回数据。

select,delete,update
UserStatusstring

数据库账号的状态。

  • LOCKED:锁定。
  • ONLINE:解锁。
ONLINE
UserNamestring

数据库账号名称。

pay_test
TenantIdstring

所属租户 ID。

t4pnum****
InstanceIdstring

所属集群 ID。

obshc32****

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "TenantUsers": [
    {
      "UserType": "Normal",
      "Description": "use for test",
      "Databases": [
        {
          "Database": "db_pay1",
          "Role": "ReadOnly",
          "Table": "tbl_pay1",
          "Privileges": "select,delete,update"
        }
      ],
      "UserStatus": "ONLINE",
      "UserName": "pay_test",
      "TenantId": "t4pnum**** ",
      "InstanceId": "obshc32****"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
2014InternalErrorThe request processing has failed due to some unknown error.内部错误

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-07-04OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:2014
出参OpenAPI 返回结构发生变更
2022-08-15OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:2014
入参OpenAPI 入参发生变更
    删除入参:AddressType
  • 本页导读 (0)