Description
You can call this operation to modify parameters of a tenant.
Call description
Prerequisites
You have the Update permission on the tenant.
For more information about the permissions, see Roles overview and Users Overview.
You have passed the authentication for the OCP application service.
Request path
PUT /api/v2/ob/clusters/{id}/tenants/{tenantId}/parameters
Path parameters
| Parameter | Type | Required | Example value | Description |
|---|---|---|---|---|
| id | Long | Yes | 1 | The ID of the cluster to which the tenant belongs. |
| tenantId | Long | Yes | 10 | The ID of the tenant. |
Request parameters
| Parameter | Type | Required | Example value | Description |
|---|---|---|---|---|
| TenantParameterParam | Array | Yes | N/A | The TenantParameterParam array. |
Data structure of TenantParameterParam
| Parameter | Type | Required | Example value | Description |
|---|---|---|---|---|
| name | String | Yes | ob_default_replica_num | The name of the parameter. The example value indicates the number of default replicas of the OceanBase cluster. |
| value | String | Yes | 2 | The value of the parameter. |
Response parameters
Basic data structure
| Parameter | Type | Description |
|---|---|---|
| successful | Boolean | Indicates whether the request was successful. |
| timestamp | Datetime | The timestamp when the server completed the request. |
| duration | Integer | The time taken by the server to process the request, in milliseconds. |
| status | Integer | An HTTP status code. |
| traceId | String | The trace ID of the request. This trace ID is used for troubleshooting. |
| server | String | The address of the application server that responded to the request. |
Examples
Sample request
PUT /api/v2/ob/clusters/1/tenants/12/parameters
body:
[
{
"name": "ob_default_replica_num",
"value": 2
}
]
Sample response
{
"duration": 3464,
"server": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2021-09-05T23:38:06.907+08:00",
"traceId": "9d3721be71e94f25"
}
