Overview
You can call this API to modify the information of a tenant in an OceanBase cluster.
Notice
When you modify the specifications of a tenant to scale it out, the cluster must have sufficient available resources.
API details
Constraints
The caller must have an AccessKey for accessing APIs. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
PUT /api/v2/instances/{instanceId}/tenants/{tenantId}
Request parameters
Query
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceId | String | Yes | The ID of the OceanBase instance in OceanBase Cloud. | ob317v4uif**** |
| tenantId | String | Yes | The ID of the tenant. | t33h8y08k**** |
Body
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| unitNum | Integer | Yes | The number of units of the tenant. | 2 |
| cpu | Integer | Yes | The number of CPU cores of the tenant. | 2 |
| memory | Integer | Yes | The size of the memory of the tenant, in GiB. | 10 |
Response parameters
| Name | Type | Description | Example value |
|---|---|---|---|
| data | object | The information of the tenant. | |
| tenantId | String | The ID of the tenant. | t33h8y08k**** |
Examples
Request example
curl -v --location \
--digest -u 'xxx:xxx' \
--request PUT \
--url https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants
-H 'X-Ob-Project-Id: <Project ID>'
Note
- A project ID uniquely identifies a project. For information about how to obtain the project ID of an instance, see Manage projects.
- Make sure that the project ID corresponding to the specified instanceId is consistent with the specified project ID.
Response example
{
"success":true,
"data":{
"tenantId":"Tenant ID"
},
"requestId":"uuid"
}