Overview
You can call this API to modify cluster-level parameters. The modified configurations may take some time to take effect.
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
PUT /api/v2/instances/{instanceId}/parameters
Request parameters
Path
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceId | String | Yes | The ID of the OceanBase cluster. | obcluster-***** |
Query
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| requestId | string | Yes | The request ID for tracking. | dc302d76-66b5-48d8-ab53-a035******** |
Body
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| name | string | Yes | The name of the parameter. | location_refresh_thread_count |
| value | string | Yes | The value of the parameter. | 4 |
Response parameters
| Parameter | Type | Description | Example value |
|---|---|---|---|
| data | array | The list of parameters. | [] |
| name | string | The name of the parameter. | location_refresh_thread_count |
| value | string | The value of the parameter. | 4 |
| success | boolean | Indicates whether the request was successful. | true |
| message | string | The description of the request. | "" |
Examples
Request example
curl --digest -u '<Your ak:sk>' \
-X PUT \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/parameters?requestId={requestId}' \
-H 'Content-Type: application/json' \
-d '[
{
"name": "location_refresh_thread_count",
"value": "4"
}
]'
Response example
JSON format
{
"data": [
{
"name": "location_refresh_thread_count",
"value": "4"
}
],
"success": true,
"message": ""
}