Overview
You can call this API to query cluster-level parameters.
API details
Constraints
The caller must have an AccessKey for accessing the APIs of OceanBase Cloud. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
GET /api/v2/instances/{instanceId}/parameters
Request parameters
Path
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceId | String | Yes | The ID of the instance. | obxxx |
Response parameters
| Parameter | Type | Description | Example value |
|---|---|---|---|
| name | string | The name of the parameter. | location_refresh_thread_count |
| currentValue | string | The current value of the parameter. | 2 |
| needReboot | boolean | Indicates whether the parameter takes effect only after a restart. | false |
| defaultValue | string | The default value of the parameter. | 4 |
| valueType | string | The type of the parameter value. | RANGE |
| acceptableValue | Array |
The valid value range of the parameter. | ["2", "64"] |
| rejectedValue | Array |
The invalid value range of the parameter. | [] |
| description | string | The description of the parameter. | The number of threads for location cache refresh. |
Examples
Request example
curl --digest -u 'ak:sk' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/parameters'
Response example
JSON format
{
"data": [
{
"name": "location_refresh_thread_count",
"currentValue": "2",
"needReboot": false,
"defaultValue": "4",
"valueType": "RANGE",
"acceptableValue": [
"2",
"64"
],
"rejectedValue": [],
"description": "The number of threads for location cache refresh."
}
]
}