Overview
You can call this API to query the CPU constraints for creating a tenant in a specified OceanBase cluster.
API details
Constraints
The caller must have an AccessKey for accessing the multi-cloud API. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
GET /api/v2/instances/{instanceId}/tenantCreateCpuConstraints
Request parameters
Query
| Name | 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
| Name | Type | Description | Example value |
|---|---|---|---|
| data | object | The information about the tenant. | |
| maxCpu | Integer | The maximum number of CPU cores. | 10 |
| minCpu | Integer | The minimum number of CPU cores. | 2 |
| unitNum | Integer | The number of units of the tenant. | 1 |
Examples
Request example
curl -v --location \
--digest -u 'xxx:xxx' \
--request GET \
--url https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenantCreateCpuConstraints
-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
}