获取数据库角色详情列表 | OceanBase 文档中心

获取数据库角色详情列表

更新时间：2023-08-10 11:45:58

功能说明

获取数据库角色详情列表。

调用说明

接口约束

调用者需要通过 OCP 应用服务鉴权。

调用者需要具备指定租户的读权限。

请求路径

GET /api/v2/ob/clusters/{id}/tenants/{tenantId}/roles

请求参数

path 参数

参数	类型	必选	示例值	描述
id	Integer	是	1	集群 ID
tenantId	Integer	是	5	租户 ID

返回结果

参数	类型	说明
data	Object	包含 contens。
├─ contents	Array	数据库角色的列表，数据库角色数据结构见下表。
successful	Boolean	请求是否成功
timestamp	Datetime	服务端完成请求的时间戳
duration	Integer	服务端处理请求的时间（毫秒）
status	Integer	符合 HTTP Status 规范的编码
traceId	String	请求的 Trace Id，用于排查问题
server	String	响应请求的服务端的地址

数据库角色的数据结构

参数	类型	说明
name	String	角色名
createTime	Datetime	用户创建时间
updateTime	Datetime	角色更新时间
globalPrivileges	StringArray	系统权限列表
objectPrivileges	Array	对象权限列表
├─ dbObject	Object	数据库对象，参见下表 dbObject 参数说明。
├─ privileges	StringArray	对象的权限列表
grantedRoles	StringArray	角色被授予的角色
userGrantees	StringArray	该角色授予给了哪些用户
roleGrantees	StringArray	该角色授予给了哪些角色

dbObject 参数说明

参数	类型	说明
objectType	String	数据库对象类型，取值范围： * TABLE 表 * VIEW 视图 * STORED_PROCEDURE 存储过程
objectName	String	数据库对象名，即表明、视图名或存储过程名。
schemaName	String	schema 名，一般与用户名相同。

示例

请求示例

获取集群 1、租户 1000001 下的角色列表。

GET /api/v2/ob/clusters/1/tenants/2000001/roles?id=1&tenantId=2000001

返回示例

{
  "data": {
    "contents": [
      {
        "createTime": "2021-09-07T15:47:13.324272+08:00",
        "globalPrivileges": [
          "CREATE_SESSION"
        ],
        "grantedRoles": [],
        "name": "CONNECT",
        "objectPrivileges": [],
        "roleGrantees": [],
        "updateTime": "2021-09-07T15:47:13.324272+08:00",
        "userGrantees": []
      },
      {
        "createTime": "2021-09-07T15:47:13.333952+08:00",
        "globalPrivileges": [
          "CREATE_TABLE",
          "CREATE_PROCEDURE",
          "CREATE_SEQUENCE",
          "CREATE_TRIGGER",
          "CREATE_TYPE"
        ],
        "grantedRoles": [],
        "name": "RESOURCE",
        "objectPrivileges": [],
        "roleGrantees": [],
        "updateTime": "2021-09-07T15:47:13.333952+08:00",
        "userGrantees": []
      },
      {
        "createTime": "2021-09-07T15:47:13.351552+08:00",
        "globalPrivileges": [
          "CREATE_SESSION",
          "CREATE_TABLE",
          "CREATE_ANY_TABLE",
          "ALTER_ANY_TABLE",
          "BACKUP_ANY_TABLE",
          "DROP_ANY_TABLE",
          "LOCK_ANY_TABLE",
          "COMMENT_ANY_TABLE",
          "SELECT_ANY_TABLE",
          "INSERT_ANY_TABLE",
          "UPDATE_ANY_TABLE",
          "DELETE_ANY_TABLE",
          "FLASHBACK_ANY_TABLE",
          "CREATE_ROLE",
          "DROP_ANY_ROLE",
          "GRANT_ANY_ROLE",
          "ALTER_ANY_ROLE",
          "AUDIT_ANY",
          "GRANT_ANY_PRIVILEGE",
          "GRANT_ANY_OBJECT_PRIVILEGE",
          "CREATE_ANY_INDEX",
          "ALTER_ANY_INDEX",
          "DROP_ANY_INDEX",
          "CREATE_ANY_VIEW",
          "DROP_ANY_VIEW",
          "CREATE_VIEW",
          "SELECT_ANY_DICTIONARY",
          "CREATE_PROCEDURE",
          "CREATE_ANY_PROCEDURE",
          "ALTER_ANY_PROCEDURE",
          "DROP_ANY_PROCEDURE",
          "EXECUTE_ANY_PROCEDURE",
          "CREATE_SYNONYM",
          "CREATE_ANY_SYNONYM",
          "DROP_ANY_SYNONYM",
          "CREATE_PUBLIC_SYNONYM",
          "DROP_PUBLIC_SYNONYM",
          "CREATE_SEQUENCE",
          "CREATE_ANY_SEQUENCE",
          "ALTER_ANY_SEQUENCE",
          "DROP_ANY_SEQUENCE",
          "SELECT_ANY_SEQUENCE",
          "CREATE_TRIGGER",
          "CREATE_ANY_TRIGGER",
          "ALTER_ANY_TRIGGER",
          "DROP_ANY_TRIGGER",
          "CREATE_PROFILE",
          "ALTER_PROFILE",
          "DROP_PROFILE",
          "CREATE_USER",
          "BECOME_USER",
          "ALTER_USER",
          "DROP_USER",
          "CREATE_TYPE",
          "CREATE_ANY_TYPE",
          "ALTER_ANY_TYPE",
          "DROP_ANY_TYPE",
          "EXECUTE_ANY_TYPE",
          "UNDER_ANY_TYPE",
          "PURGE_DBA_RECYCLEBIN",
          "CREATE_ANY_OUTLINE",
          "ALTER_ANY_OUTLINE",
          "DROP_ANY_OUTLINE",
          "SYSKM",
          "CREATE_TABLESPACE",
          "ALTER_TABLESPACE",
          "DROP_TABLESPACE",
          "SHOW_PROCESS",
          "ALTER_SYSTEM",
          "CREATE_DATABASE_LINK",
          "CREATE_PUBLIC_DATABASE_LINK",
          "DROP_DATABASE_LINK",
          "ALTER_SESSION",
          "ALTER_DATABASE"
        ],
        "grantedRoles": [],
        "name": "DBA",
        "objectPrivileges": [],
        "roleGrantees": [],
        "updateTime": "2021-09-07T15:47:13.351552+08:00",
        "userGrantees": []
      },
      {
        "createTime": "2021-09-07T15:47:13.507267+08:00",
        "globalPrivileges": [],
        "grantedRoles": [],
        "name": "PUBLIC",
        "objectPrivileges": [],
        "roleGrantees": [],
        "updateTime": "2021-09-07T15:47:13.507267+08:00",
        "userGrantees": []
      }
    ]
  },
  "duration": 318,
  "server": "a83ad33525",
  "status": 200,
  "successful": true,
  "timestamp": "2021-09-07T15:48:30.383+08:00",
  "traceId": "4f1d5757763a47bc"
}