Description
You can call this operation to query parameters of the specified OceanBase cluster.
Call description
Prerequisites
You have the read-only permission on the specified OceanBase cluster.
For more information about the permissions, see Overview.
You have passed the authentication for the OceanBase Cloud Platform (OCP) application service.
Request path
GET /api/v2/ob/clusters/{id}/parameters
Path parameters
| Parameter | Type | Required | Example value | Description |
|---|---|---|---|---|
| id | Integer | Yes | 100 | The ID of the target OceanBase cluster. |
Response parameters
Basic data structure
| Parameter | Type | Description |
|---|---|---|
| data | Array | For more information, see Data structure of ClusterParameter. |
| successful | Boolean | Indicates whether the request was successful. |
| timestamp | Datetime | The timestamp when the server completed the request. |
| duration | Integer | The amount of time taken by the server to process the request, in milliseconds. |
| status | Integer | The HTTP status code. |
| traceId | String | The trace ID of the request. This trace ID is used for troubleshooting. |
| server | String | The address of the application server that responded to the request. |
Data structure of ClusterParameter
| Parameter | Type | Description |
|---|---|---|
| name | String | The name of the parameter. |
| section | String | The category of the parameter. |
| parameterType | Enum | The effective scope of the parameter. Valid values: OB_CLUSTER_PARAMETER is used by default for comparability with the behavior of clusters of earlier versions. |
| editionCompatibleType | Enum | The edition of OceanBase Database that supports the parameter. Valid values: |
| defaultValue | String | The default value. |
| valueRange | Object | For more information, see Data structure of ValueRange. |
| currentValue | Object | For more information, see Data structure of ClusterParameterValue. |
| needRestart | Boolean | Indicates whether a modification takes effect after a restart. |
| readonly | Boolean | Indicates whether the parameter is read-only. |
| description | String | The description of the parameter. |
Data structure of ValueRange
| Parameter | Type | Description |
|---|---|---|
| type | String | The data type of the parameter. |
| allowedValues | String | The allowed values of the parameter. |
| maxValue | String | The maximum value of the parameter. |
| minValue | String | The minimum value of the parameter. |
Data structure of ClusterParameterValue
| Parameter | Type | Description |
|---|---|---|
| values | Array | The values of the parameter. |
| obParameters | Array | For more information, see Data structure of ObParameter. |
Data structure of ObParameter
| Parameter | Type | Description |
|---|---|---|
| zone | String | The name of the zone. |
| svrIp | String | The IP address of the OBServer node. |
| svrPort | Integer | The port number of the OBServer node. |
| name | String | The name of the parameter. |
| value | String | The value of the parameter. |
Examples
Sample request
GET /api/v2/ob/clusters/100/parameters
Sample response
{
"data": {
"contents": [{
"currentValue": {
"obParameters": [{
"name": "ob_query_switch_leader_retry_timeout",
"readonly": false,
"svrIp": "xxx.xxx.xxx.xxx",
"svrPort": 2882,
"tenantId": 1,
"tenantName": "sys",
"value": "0ms",
"zone": "zone1"
}],
"singleValueInCluster": true,
"tenantValues": [{
"tenantId": 1,
"tenantName": "sys",
"value": "0ms"
}],
"values": ["0ms"]
},
"name": "ob_query_switch_leader_retry_timeout",
"parameterType": "OB_TENANT_PARAMETER"
},
{
"currentValue": {
"obParameters": [{
"name": "enable_sql_extension",
"readonly": false,
"svrIp": "xxx.xxx.xxx.xxx",
"svrPort": 2882,
"tenantId": 1,
"tenantName": "sys",
"value": "False",
"zone": "zone1"
}],
"singleValueInCluster": true,
"tenantValues": [{
"tenantId": 1,
"tenantName": "sys",
"value": "False"
}],
"values": ["False"]
},
"defaultValue": "FALSE",
"description": "specifies whether to allow use some oracle mode features in mysql mode",
"editionCompatibleType": "ALL",
"name": "enable_sql_extension",
"needRestart": false,
"parameterType": "OB_TENANT_PARAMETER",
"readonly": false,
"section": "OBSERVER",
"valueRange": {
"allowedValues": "TRUE,FALSE",
"type": "ENUM"
}
},
{
"currentValue": {
"obParameters": [{
"name": "tenant_disk_max_size",
"readonly": false,
"svrIp": "xxx.xxx.xxx.xxx",
"svrPort": 2882,
"tenantId": 1,
"tenantName": "sys",
"value": "0",
"zone": "zone1"
}],
"singleValueInCluster": true,
"tenantValues": [{
"tenantId": 1,
"tenantName": "sys",
"value": "0"
}],
"values": ["0"]
},
"defaultValue": "0M",
"description": "Upper limit of the tenants total storage size which consists of all the replicas",
"editionCompatibleType": "ALL",
"name": "tenant_disk_max_size",
"needRestart": false,
"parameterType": "OB_TENANT_PARAMETER",
"readonly": false,
"section": "OBSERVER",
"valueRange": {
"minValue": "0M",
"type": "CAPACITY"
}
},
{
"currentValue": {
"obParameters": [{
"name": "job_queue_processes",
"readonly": false,
"svrIp": "xxx.xxx.xxx.xxx",
"svrPort": 2882,
"tenantId": 1,
"tenantName": "sys",
"value": "1000",
"zone": "zone1"
}],
"singleValueInCluster": true,
"tenantValues": [{
"tenantId": 1,
"tenantName": "sys",
"value": "1000"
}],
"values": ["1000"]
},
"defaultValue": "1000",
"description": "specifies the maximum number of job slaves per instance that can be created for the execution of DBMS_JOB jobs and Oracle Scheduler (DBMS_SCHEDULER) jobs.",
"editionCompatibleType": "ALL",
"name": "job_queue_processes",
"needRestart": false,
"parameterType": "OB_TENANT_PARAMETER",
"readonly": false,
"section": "OBSERVER",
"valueRange": {
"maxValue": "1000",
"minValue": "0",
"type": "INT"
}
},
{
"currentValue": {
"obParameters": [{
"name": "ob_proxy_readonly_transaction_routing_policy",
"readonly": false,
"svrIp": "xxx.xxx.xxx.xxx",
"svrPort": 2882,
"tenantId": 1,
"tenantName": "sys",
"value": "True",
"zone": "zone1"
}],
"singleValueInCluster": true,
"tenantValues": [{
"tenantId": 1,
"tenantName": "sys",
"value": "True"
}],
"values": ["True"]
},
"defaultValue": "TRUE",
"description": "Proxy route policy for readonly sql",
"editionCompatibleType": "ALL",
"name": "ob_proxy_readonly_transaction_routing_policy",
"needRestart": false,
"parameterType": "OB_TENANT_PARAMETER",
"readonly": false,
"section": "OBSERVER",
"valueRange": {
"allowedValues": "TRUE,FALSE",
"type": "ENUM"
}
},
{
"currentValue": {
"obParameters": [{
"name": "connection_control_max_connection_delay",
"readonly": false,
"svrIp": "xxx.xxx.xxx.xxx",
"svrPort": 2882,
"tenantId": 1,
"tenantName": "sys",
"value": "2147483647",
"zone": "zone1"
}],
"singleValueInCluster": true,
"tenantValues": [{
"tenantId": 1,
"tenantName": "sys",
"value": "2147483647"
}],
"values": ["2147483647"]
},
"defaultValue": "2147483647",
"description": "The maximum delay in milliseconds for server response to failed connection attempts, if connection_control_failed_connections_threshold is greater than zero",
"editionCompatibleType": "ALL",
"name": "connection_control_max_connection_delay",
"needRestart": false,
"parameterType": "OB_TENANT_PARAMETER",
"readonly": false,
"section": "OBSERVER",
"valueRange": {
"maxValue": "2147483647",
"minValue": "1000",
"type": "INT"
}
},
{
"currentValue": {
"obParameters": [{
"name": "connection_control_min_connection_delay",
"readonly": false,
"svrIp": "xxx.xxx.xxx.xxx",
"svrPort": 2882,
"tenantId": 1,
"tenantName": "sys",
"value": "1000",
"zone": "zone1"
}],
"singleValueInCluster": true,
"tenantValues": [{
"tenantId": 1,
"tenantName": "sys",
"value": "1000"
}],
"values": ["1000"]
},
"defaultValue": "1000",
"description": "The minimum delay in milliseconds for server response to failed connection attempts, if connection_control_failed_connections_threshold is greater than zero.",
"editionCompatibleType": "ALL",
"name": "connection_control_min_connection_delay",
"needRestart": false,
"parameterType": "OB_TENANT_PARAMETER",
"readonly": false,
"section": "OBSERVER",
"valueRange": {
"maxValue": "2147483647",
"minValue": "1000",
"type": "INT"
}
},
{
"currentValue": {
"obParameters": [{
"name": "connection_control_failed_connections_threshold",
"readonly": false,
"svrIp": "xxx.xxx.xxx.xxx",
"svrPort": 2882,
"tenantId": 1,
"tenantName": "sys",
"value": "0",
"zone": "zone1"
}],
"singleValueInCluster": true,
"tenantValues": [{
"tenantId": 1,
"tenantName": "sys",
"value": "0"
}],
"values": ["0"]
},
"defaultValue": "0",
"description": "The number of consecutive failed connection attempts permitted to accounts before the server adds a delay for subsequent connection attempts",
"editionCompatibleType": "ALL",
"name": "connection_control_failed_connections_threshold",
"needRestart": false,
"parameterType": "OB_TENANT_PARAMETER",
"readonly": false,
"section": "OBSERVER",
"valueRange": {
"maxValue": "2147483647",
"minValue": "0",
"type": "INT"
}
},
{
"currentValue": {
"obParameters": [{
"name": "open_cursors",
"readonly": false,
"svrIp": "xxx.xxx.xxx.xxx",
"svrPort": 2882,
"tenantId": 1,
"tenantName": "sys",
"value": "50",
"zone": "zone1"
}],
"singleValueInCluster": true,
"tenantValues": [{
"tenantId": 1,
"tenantName": "sys",
"value": "50"
}],
"values": ["50"]
},
"defaultValue": "50",
"description": "specifies the maximum number of open cursors a session can have at once. can use this parameter to prevent a session from opening an excessive number of cursors. Range: [0, 65535] in integer",
"editionCompatibleType": "ALL",
"name": "open_cursors",
"needRestart": false,
"parameterType": "OB_TENANT_PARAMETER",
"readonly": false,
"section": "OBSERVER",
"valueRange": {
"maxValue": "65535",
"minValue": "0",
"type": "INT"
}
},
{
"currentValue": {
"obParameters": [{
"editLevel": "READONLY",
"info": "the directory for the data file",
"name": "data_dir",
"readonly": true,
"section": "SSTABLE",
"svrIp": "xxx.xxx.xxx.xxx",
"svrPort": 2882,
"value": "/home/admin/oceanbase/store/ob3233",
"zone": "zone1"
}],
"serverValues": [{
"svrIp": "xxx.xxx.xxx.xxx",
"svrPort": 2882,
"value": "/home/admin/oceanbase/store/ob3233"
}],
"singleValueInCluster": true,
"values": ["/home/admin/oceanbase/store/ob3233"]
},
"defaultValue": "store",
"description": "the directory for the data file",
"editionCompatibleType": "ALL",
"name": "data_dir",
"needRestart": false,
"parameterType": "OB_CLUSTER_PARAMETER",
"readonly": true,
"section": "SSTABLE",
"valueRange": {
"type": "STRING"
}
}]
},
"duration": 126,
"server": "74f95ea2f4",
"status": 200,
"successful": true,
"timestamp": "2025-03-20T14:22:13.614+08:00",
"traceId": "b99d1915babb248a"
}
