Overview
You can call this API to query tenant-level parameters.
API details
Constraints
The caller must have an AccessKey for accessing 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}/tenants/{tenantId}/parameters
Request parameters
Path
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceId | String | Yes | The ID of the instance. | obxxx |
| tenantId | String | Yes | The ID of the tenant. | txxx |
Response parameters
| Parameter | Type | Description | Example value |
|---|---|---|---|
| name | string | The name of the parameter. | connect_timeout |
| currentValue | string | The current value of the parameter. | 10 |
| needReboot | boolean | Indicates whether a restart is required for the parameter to take effect. | false |
| defaultValue | string | The default value of the parameter. | 10 |
| valueType | string | The type of the parameter value. | RANGE |
| acceptableValue | Array |
The valid range of the parameter value. | ["2", "31536000"] |
| rejectedValue | Array |
The invalid range of the parameter value. | [] |
| description | string | The description of the parameter. | The connection timeout period, in seconds. |
Examples
Request example
curl --digest -u 'ak:sk' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/parameters'
Response example
JSON format
{
"data": [
{
"name": "connect_timeout",
"currentValue": "10",
"needReboot": false,
"defaultValue": "10",
"valueType": "RANGE",
"acceptableValue": [
"2",
"31536000"
],
"rejectedValue": [],
"description": "The connection timeout period, in seconds."
}
]
}