All Products
Search

This Product

    ApsaraDB for OceanBase:CreateTenant

    Document Center

    ApsaraDB for OceanBase:CreateTenant

    Last Updated:Nov 14, 2025

    You can call this operation to create a tenant.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • For mandatory resource types, indicate with a prefix of * .
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    oceanbase:CreateTenantcreate
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    TenantNamestringYes

    The name of the tenant.
    It must start with a letter or an underscore (), and contain 2 to 20 characters, which can be uppercase letters, lowercase letters, digits, and underscores (). It cannot be set to sys.

    		pay_online
    CpuintegerYes

    The number of CPU cores of the tenant.

    Note
    The CPU specification of a single tenant cannot exceed that of the corresponding cluster.
    For example, if the specification of the cluster is 14 CPU cores and 70 GB of memory, the CPU specification of the tenant cannot exceed 14 cores.
    		2
    MemoryintegerYes

    The memory size of the tenant, in GB.

    Note
    The memory size of a single tenant cannot exceed that of the corresponding cluster.
    For example, if the specification of the cluster is 14 CPU cores and 70 GB of memory, the memory size of the tenant cannot exceed 70 GB.
    		10
    TimeZonestringYes

    The time zone of the tenant. For more information, see DescribeTimeZones .

    		Asia/Shanghai
    TenantModestringYes

    The tenant mode.
    Valid values: Oracle and MySQL.
    For more information, see DescribeInstanceTenantModes .

    		Oracle
    CharsetstringYes

    The character set.
    For more information, see DescribeCharset .

    		utf8mb4
    InstanceIdstringYes

    The ID of the OceanBase cluster.

    		ob317v4uif****
    UserVpcIdstringYes

    The ID of the VPC.
    If no suitable VPC is available, create a VPC as prompted.
    For more information, see "What is a VPC".

    		vpc-bp1d2q3mhg9i23ofi****
    UserVSwitchIdstringYes

    The ID of the vSwitch.
    If no suitable vSwitch is available, create a vSwitch as prompted.
    For more information, see Use a vSwitch.

    		vsw-bp11k1aypnzu1l3whi****
    PrimaryZonestringYes

    The primary zone of the tenant.
    It is one of the zones in which the cluster is deployed.

    		cn-hangzhou-h
    DescriptionstringNo

    The description of the database.

    		this is a test database
    UnitNumintegerNo

    The number of resource distribution nodes in the tenant.
    The number is determined by the deployment mode of the cluster. If the cluster is deployed in 2-2-2 mode, the maximum number of resource distribution nodes is 2.

    		2
    ReadOnlyZoneListstringNo

    Specifies to create a read-only zone. Separate the names of multiple zones with commas (,).

    Notice At present, this parameter is unavailable.

    		cn-shanghai-g-ro,cn-shanghai-h-ro
    LogDisklongNo

    The size of the log disk allocated to the tenant, in GB.

    		128
    CreateParamsobjectNo

    The initialization parameters.

    stringNo

    The initialization parameters.

    		{\"LOWER_CASE_TABLE_NAMES\":\"1\"}
    UserVpcOwnerIdstringNo

    The ID of the VPC owner.

    		vpc-********

    Response parameters

    ParameterTypeDescriptionExample
    object

    The return result of the request.

    TenantIdstring

    The ID of the tenant.

    		t33h8y08k****
    RequestIdstring

    The request ID.

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

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError message
    500InternalErrorThe request processing has failed due to some unknown error.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-04-15The Error code has changed. The request parameters of the API has changedView Change Details
    2023-11-20The Error code has changedView Change Details
    2023-10-30The Error code has changed. The request parameters of the API has changedView Change Details