Overview
You can call this API to query cluster-level parameters.
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
GET /api/v2/instances/{instanceId}/parameters
Request parameters
Path
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceId | String | Yes | The ID of the OceanBase cluster.
NoteMulti-tenant instances are not supported in the current version. |
obcluster-***** |
Query
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| requestId | String | Yes | The request ID for tracing. | dc302d76-66b5-48d8-ab53-a035******** |
Response parameters
| Parameter | Type | Description | Example value |
|---|---|---|---|
| name | string | The parameter name. | location_refresh_thread_count |
| currentValue | string | The current value of the parameter. | 2 |
| needReboot | boolean | Indicates whether to restart the instance for the parameter to take effect. | false |
| defaultValue | string | The default value of the parameter. | 4 |
| valueType | string | The value type of the parameter. | RANGE |
| acceptableValue | Array |
The legal value range of the parameter. | ["2", "64"] |
| rejectedValue | Array |
The illegal 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 '<your ak:sk>' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/parameters?requestId={requestId}'
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."
}
],
"server": "xxx.xxx.x.xxx:xxxx"
}