全部产品
Search

搜索本产品

    云数据库 OceanBase （文档停止维护）：CreateTenant - 创建租户

    文档中心

    云数据库 OceanBase （文档停止维护）：CreateTenant - 创建租户

    更新时间：Aug 28, 2026

    创建一个租户。

    调试

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

    调试

    授权信息

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

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    oceanbase:CreateTenant

    create

    *全部资源

    *

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    TenantName

    string

    是

    租户名称。
    长度为 2~20 个字符，支持英文字母、数字和下划线，区分大小写，必须以字母或下划线开头。 不可设置为 sys。

    pay_online
    Cpu

    integer

    是

    租户的 CPU 大小，单位：核数（Cores）。

    说明


    单个租户的 CPU 不能超过所属集群的规格。
    例如：集群为 14C70GB，则 CPU 不超过 14C。

    2
    Memory

    integer

    是

    租户内存大小，单位 GB。

    说明


    单个租户的内存不能超过所属集群的规格。
    例如：集群为 14C70GB，则内存不超过 70GB。

    10
    TimeZone

    string

    是

    租户所在时区。 详情参见 DescribeTimeZones 。

    Asia/Shanghai
    TenantMode

    string

    是

    租户模式。 当前支持 Oracle 模式（Oracle）、MySQL 模式（MySQL）。
    详情参见 DescribeInstanceTenantModes 。

    Oracle
    Charset

    string

    是

    字符集。 详情参见：DescribeCharset。

    utf8mb4
    InstanceId

    string

    是

    OceanBase 集群 ID。

    ob317v4uif****
    UserVpcId

    string

    是

    专有网络（VPC） ID。
    如无合适的 VPC，请根据页面提示创建一个 VPC。
    详情参见什么是专有网络。

    vpc-bp1d2q3mhg9i23ofi****
    UserVSwitchId

    string

    是

    虚拟交换机（VSwitch）ID。
    如无合适的 VSwitch，请根据页面提示创建一个。
    详情参见使用交换机。

    vsw-bp11k1aypnzu1l3whi****
    PrimaryZone

    string

    是

    租户的主可用区。 其为集群部署可用区中的一个。

    cn-hangzhou-h
    Description

    string

    否

    数据库描述信息。

    this is a test database
    UnitNum

    integer

    否

    租户的资源分布节点数。 其与集群的部署模式相耦合，如集群模式为 2-2-2，则最后分布节点数最多为 2 个。

    2
    ReadOnlyZoneList

    string

    否

    创建只读副本的可用区，当传入多个可用区的时候，以逗号分隔。

    重要 此参数暂时不可用。

    cn-shanghai-g-ro,cn-shanghai-h-ro
    LogDisk

    integer

    否

    租户的已分配日志盘大小，单位：GB。

    128
    CreateParams

    object

    否

    创建租户时，初始化参数

    string

    否

    创建租户时，初始化参数

    {\"LOWER_CASE_TABLE_NAMES\":\"1\"}
    UserVpcOwnerId

    string

    否

    用户 vpc 的 ownerId

    vpc-********

    返回参数

    名称

    类型

    描述

    示例值

    object

    请求的返回结果。

    TenantId

    string

    租户 ID。

    t33h8y08k****
    RequestId

    string

    请求 ID。

    EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C

    示例

    正常返回示例

    JSON格式

    {
  "TenantId": "t33h8y08k****",
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C"
}

    错误码

    HTTP status code

    错误码

    错误信息

    描述
    500 InternalError The request processing has failed due to some unknown error. 内部错误

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

    变更历史

    更多信息，参考变更详情。