Overview
You can call this API to query tenant-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}/tenants/{tenantId}/parameters
Request parameters
Path
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceId | String | Yes | The ID of the OceanBase cluster. | obcluster-***** |
| tenantId | String | Yes | The ID of the tenant. | t4louaeei**** |
Query
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| requestId | String | Yes | The ID of the request, which is used for tracing. | dc302d76-66b5-48d8-ab53-a035******** |
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 to restart the tenant 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 values for the parameter. | ["2", "31536000"] |
| rejectedValue | Array |
The invalid range of values for the parameter. | [] |
| description | string | The description of the parameter. | The connection timeout period, in seconds. |
Examples
Request example
curl --digest -u '<Your ak:sk>' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/parameters?requestId={requestId}'
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."
}
],
"server": "xxx.xxx.x.xxx:xxxx"
}