Overview
You can call this API to modify cluster-level parameters.
API details
Constraints
The caller must have an AccessKey for accessing APIs. 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 instance. | obxxx |
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 | Yes | The name of the parameter. | location_refresh_thread_count |
| value | string | Yes | The value of the parameter. | 4 |
| success | boolean | Indicates whether the call was successful. | true | |
| message | string | The description of the call result. | "" |
Examples
Request example
curl --digest -u 'ak:sk' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/parameter' \
--data '{}'
Response example
JSON format
{
"data": [
{
"name": "location_refresh_thread_count",
"value": "4"
}
],
"success": true,
"message": ""
}