Overview
You can call this API to modify the CPU limits for a tenant in an OceanBase cluster.
API details
Constraints
The caller must have an AccessKey for accessing APIs of OceanBase Cloud. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
GET /api/v2/instances/{instanceId}/tenants/{tenantId}/tenantModifyCpuConstraints
Request parameters
Query
| **** | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceId | String | Yes | The ID of the OceanBase cluster. | ob317v4uif**** |
| tenantId | String | Yes | The ID of the tenant. | t33h8y08k**** |
Response parameters
| Parameter | Type | Description | Example value |
|---|---|---|---|
| data | Object | The information about the CPU resources of the tenant. | |
| CPU | Integer | The number of CPU cores for the tenant. | 10 |
| maxMem | Long | The maximum size of memory allowed for a single unit, in GiB. | 55 |
| minMem | Long | The minimum size of memory allowed for a single unit, in GiB. | 20 |
| unitNum | Integer | The number of resource units for the tenant. | 1 |
Examples
Request example
curl
--digest -u 'xxx:xxx' \
--request GET \
--url https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/tenantModifyCpuConstraints
-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
JSON format
{
"data":[
{
"maxCpu":10,
"minCpu":2,
"unitNum":1
},
{
"maxCpu":8,
"minCpu":2,
"unitNum":2
}
],
"requestId":"fdcdc581-9f6d-4aae-8448-dfafadsfdas",
"success":true
}
