Description
You can call this operation to modify parameters of an OceanBase cluster.
Call description
Prerequisites
You have the Update permission on the OceanBase cluster.
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}/parameters
Path parameters
| Parameter | Type | Required | Example value | Description |
|---|---|---|---|---|
| id | Integer | Yes | 1 | The ID of the OceanBase cluster. |
Request parameters
| Parameter | Type | Required | Example value | Description |
|---|---|---|---|---|
| SetClusterParameterParam | Array | Yes | N/A | The SetClusterParameterParam array. For more information about the data structure, see Data structure of SetClusterParameterParam . |
Data structure of SetClusterParameterParam
| Parameter | Type | Required | Description |
|---|---|---|---|
| name | String | Yes | The name of the parameter. |
| value | String | Yes | 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/parameters
body:
[
{
"name": "balancer_emergency_percentage",
"value": 75
}
]
Sample response
{
"duration": 3464,
"server": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2021-09-05T23:38:06.907+08:00",
"traceId": "9d3721be71e94f25"
}
