Description
You can call this operation to modify parameters of the specified OceanBase cluster.
Call description
Prerequisites
You have the permissions to update the specified OceanBase cluster.
For more information about the permissions, see Overview.
You have passed the authentication for the OceanBase Cloud Platform (OCP) application service.
Request path
PUT /api/v2/ob/clusters/{id}/parameters
Request parameters
Path parameters
| Parameter | Type | Required | Example value | Description |
|---|---|---|---|---|
| id | Integer | Yes | 1 | The ID of the target cluster. |
Body parameters
| Parameter | Type | Required | Example value | Description |
|---|---|---|---|---|
| SetClusterParameterParam | Array | Yes | NA | For more information, 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. |
| parameterType | Enum | No | The effective scope of the parameter. Valid values: OB_CLUSTER_PARAMETER is used by default for comparability with the behavior of clusters of earlier versions. |
| zones | Array | No | The zones on which the parameter modification takes effect. If you specify this parameter, you cannot specify the servers parameter. If you specify neither the zones nor servers parameter, the parameter modification takes effect on all zones. |
| servers | Array | No | The OBServer nodes on which the parameter modification takes effect. If you specify this parameter, you cannot specify the zones parameter. If you specify neither the zones nor servers parameter, the parameter modification takes effect on all OBServer nodes. |
| tenants | Array | No | The tenants on which the parameter modification takes effect. This parameter takes effect only if you set parameterType to OB_TENANT_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 amount of time taken by the server to process the request, in milliseconds. |
| status | Integer | The 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"
}