文档

CreateTenantUser - 创建租户用户

更新时间:

在指定租户下创建一个访问数据库的账号。

调试

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

授权信息

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

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

请求参数

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

OceanBase 集群 ID。

ob317v4uif****
TenantIdstring

租户 ID。

t4pnum****
UserNamestring

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

pay_test
UserTypestring

用户类型。

  • Normal:普通账户。
  • Admin:超级账户。
  • ReadonlyAccount:只读账户,仅 MySQL 租户包含只读账户。
Normal
UserPasswordstring

数据库账号访问密码。

说明
必须包含大写英文字符、小写英文字符、数字、特殊字符占三种,长度为 10-32 位; 特殊字符为:!@#$%^*()_+-=
!Aliyun4Oceanbase
Rolesstring

用户的角色信息。
普通用户填写账户的信息,其为 JSON 格式的字符串,默认为一个数组,数组内包含 Database(MySQL 模式)信息和角色信息(Role)。角色包含以下几类:

  • 读写权限(ReadWrite):ALL PRIVILEGES。
  • 只读权限(ReadOnly):SELECT。
  • DDL 权限(DDL):CREATE,DROP,ALTER,SHOW VIEW,CREATE VIEW。
  • DML 权限:SELECT, INSERT, UPDATE, DELETE, SHOW VIEW。
  • DML 权限(DML):SELECT,INSERT,UPDATE,DELETE,SHOW VIEW。
说明
  • Oracle 模式:无需填写。
  • MySQL 模式:超级账户默认为 ALL PRIVILEGES,无需填写。
  • [{"Database":"oceanbase1","Role":"readwrite"},{"Database":"oceanbase2","Role":"readonly"}]
    Descriptionstring

    数据库描述信息。

    this is a test database
    EncryptionTypestring

    加密方式。

    RAS

    有关请求 Endpoint 列表,请参见 API 参考 > 调用方式。

    返回参数

    名称类型描述示例值
    object

    请求的返回结果。

    RequestIdstring

    请求 ID。

    EE205C00-30E4-****-****-87E3A8A2AA0C
    TenantUserobject

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

    UserTypestring

    用户类型。

    • Normal:普通账户。
    • Admin:超级账户。
    • ReadonlyAccount:只读账户,仅 MySQL 租户包含只读账户。
    Normal
    Rolesobject []

    账户对应的角色权限信息

    Databasestring

    数据库名称。

    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
    UserStatusstring

    数据库账号的状态。

    • LOCKED:锁定。
    • ONLINE:解锁。
    说明 创建完成的账户默认状态为 ONLINE。
    ONLINE
    UserNamestring

    数据库账号名称。

    pay_test

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
      "TenantUser": {
        "UserType": "Normal",
        "Roles": [
          {
            "Database": "db_pay1",
            "Role": "ReadOnly"
          }
        ],
        "UserStatus": "ONLINE",
        "UserName": "pay_test"
      }
    }

    错误码

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

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

    变更历史

    变更时间变更内容概要操作
    2023-12-26OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:500
    出参OpenAPI 返回结构发生变更
    2023-07-04OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:500
    2023-04-06OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:500
    入参OpenAPI 入参发生变更
      新增入参:EncryptionType
    • 本页导读 (0)