CreateTenant - ApsaraDB for OceanBase - Alibaba Cloud Documentation Center

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
TenantName	string	Yes	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
Cpu	integer	Yes	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
Memory	integer	Yes	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
TimeZone	string	Yes	The time zone of the tenant. For more information, see DescribeTimeZones .	Asia/Shanghai
TenantMode	string	Yes	The tenant mode. Valid values: Oracle and MySQL. For more information, see DescribeInstanceTenantModes .	Oracle
Charset	string	Yes	The character set. For more information, see DescribeCharset .	utf8mb4
InstanceId	string	Yes	The ID of the OceanBase cluster.	ob317v4uif****
UserVpcId	string	Yes	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****
UserVSwitchId	string	Yes	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****
PrimaryZone	string	Yes	The primary zone of the tenant. It is one of the zones in which the cluster is deployed.	cn-hangzhou-h
Description	string	No	The description of the database.	this is a test database
UnitNum	integer	No	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
ReadOnlyZoneList	string	No	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
LogDisk	long	No	The size of the log disk allocated to the tenant, in GB.	128

Response parameters

Parameter	Type	Description	Example
	object	The return result of the request.
TenantId	string	The ID of the tenant.	t33h8y08k****
RequestId	string	The request ID.	EE205C00-30E4-**-**-87E3A8A2AA0C

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message
500	InternalError	The request processing has failed due to some unknown error.

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

Change history

Change time	Summary of changes	Operation
2024-04-15	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-11-20	The Error code has changed	View Change Details
2023-10-30	The Error code has changed. The request parameters of the API has changed	View Change Details