Description
You can call this operation to query the parameter metadata of an OceanBase cluster.
Call description
Prerequisites
You have the Read-only permission on the OceanBase cluster.
For more information about the permissions, see Roles overview and Users Overview.
You have passed the authentication for the OCP application service.
Request path
GET /api/v2/ob/clusters/parameterInfo
Response parameters
Basic data structure
| Parameter | Type | Description |
|---|---|---|
| data | Array | The ParameterInfo array. |
| successful | Boolean | Indicates whether the request was successful. |
| timestamp | Datetime | The timestamp when the server completed the request. |
| duration | Integer | The time taken by the server to process the request, in milliseconds. |
| status | Integer | An 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 ParameterInfo
| Parameter | Type | Description |
|---|---|---|
| name | String | The name of the parameter. |
| version | String | The version of the OceanBase cluster. |
| type | String | The type of the parameter. Valid values: BOOL CAPACITY DOUBLE INT MOMENT STRING STRING_LIST TIME |
| allowedStringValues | String | The allowed values of the parameter. |
| maxValue | String | The maximum value of the parameter. |
| minValue | String | The minimum value of the parameter. |
| defaultValue | String | The default value of the parameter. |
| needRestart | Boolean | Indicates whether a cluster restart was required. |
| readonly | Boolean | Indicates whether the parameter was read-only. |
| description | String | The description of the parameter. |
Examples
Sample request
GET /api/v2/ob/clusters/parameterInfo
Sample response
{
"data": {
"contents": [
{
"allowedStringValues": null,
"defaultValue": "0",
"description": "Indicates whether trace logs were recorded.",
"explanation": null,
"id": 31,
"maxValue": null,
"minValue": null,
"name": "enable_record_trace_log",
"needRestart": false,
"readonly": false,
"type": "BOOL",
"version": "1.4.1"
},
{
"allowedStringValues": null,
"defaultValue": "1",
"description": "The priority of the baseline data row cache in the cache system.",
"explanation": null,
"id": 123,
"maxValue": null,
"minValue": "1",
"name": "user_row_cache_priority",
"needRestart": false,
"readonly": false,
"type": "INT",
"version": "1.4.1"
},
{
"allowedStringValues": null,
"defaultValue": 40",
"description": "When the available memory is less than this threshold, a global freeze is triggered.",
"explanation": null,
"id": 43,
"maxValue": "99",
"minValue": "1",
"name": "global_major_freeze_residual_memory",
"needRestart": false,
"readonly": false,
"type": "INT",
"version": "1.4.1"
},
{
"allowedStringValues": null,
"defaultValue": "auto",
"description": "The partition balance policy of the cluster.",
"explanation": null,
"id": 380,
"maxValue": null,
"minValue": null,
"name": "_partition_balance_strategy",
"needRestart": false,
"readonly": false,
"type": "STRING",
"version": "2.2.52"
},
{
"allowedStringValues": null,
"defaultValue": "10s",
"description": "The timeout period for detecting invalid sockets.",
"explanation": null,
"id": 330,
"maxValue": "2h",
"minValue": "0s",
"name": "dead_socket_detection_timeout",
"needRestart": false,
"readonly": false,
"type": "TIME",
"version": "2.2.30"
},
{
"allowedStringValues": null,
"defaultValue": "2G",
"description": "The maximum memory available to Root Service.",
"explanation": null,
"id": 218,
"maxValue": null,
"minValue": "2G",
"name": "rootservice_memory_limit",
"needRestart": false,
"readonly": false,
"type": "CAPACITY",
"version": "2.1.0"
},
{
"allowedStringValues": null,
"defaultValue": "1h",
"description": "The time required for allocating the remaining memory of the MemStore after the write speed is limited. This parameter controls the write speed by controlling the memory allocation progress.",
"explanation": null,
"id": 232,
"maxValue": "3d",
"minValue": "1s",
"name": "write_throttling_maximum_duration",
"needRestart": false,
"readonly": false,
"type": "TIME",
"version": "2.1.11"
},
{
"allowedStringValues": null,
"defaultValue": "0",
"description": "Specifies whether to allow a user to create and modify system tables. This parameter is usually used in system upgrades.",
"explanation": null,
"id": 36,
"maxValue": null,
"minValue": null,
"name": "enable_sys_table_ddl",
"needRestart": false,
"readonly": false,
"type": "BOOL",
"version": "1.4.1"
},
{
"allowedStringValues": null,
"defaultValue": "100",
"description": "The percentage of compacted replicas at which the major compaction task is considered completed.",
"explanation": null,
"id": 74,
"maxValue": "100",
"minValue": "5",
"name": "merger_completion_percentage",
"needRestart": false,
"readonly": false,
"type": "INT",
"version": "1.4.1"
},
{
"allowedStringValues": null,
"defaultValue": "30s",
"description": "The timeout period of internal SQL requests of the system.",
"explanation": null,
"id": 50,
"maxValue": "10m",
"minValue": "1000us",
"name": "internal_sql_execute_timeout",
"needRestart": false,
"readonly": false,
"type": "TIME",
"version": "1.4.1"
},
{
"allowedStringValues": null,
"defaultValue": "60s",
"description": "The time threshold for heartbeat missing at which a server is considered temporarily offline.",
"explanation": null,
"id": 105,
"maxValue": null,
"minValue": "15s",
"name": "server_temporary_offline_time",
"needRestart": false,
"readonly": false,
"type": "TIME",
"version": "1.4.1"
},
{
"allowedStringValues": null,
"defaultValue": "1",
"description": "Specifies whether to enable asynchronous writing of system logs.",
"explanation": null,
"id": 191,
"maxValue": null,
"minValue": null,
"name": "enable_async_syslog",
"needRestart": false,
"readonly": false,
"type": "BOOL",
"version": "2.0.0"
},
{
"allowedStringValues": null,
"defaultValue": "0",
"description": "Specifies whether to enable authentication for Oracle tenants.",
"explanation": null,
"id": 391,
"maxValue": null,
"minValue": null,
"name": "_enable_oracle_priv_check",
"needRestart": false,
"readonly": false,
"type": "BOOL",
"version": "2.2.60"
},
{
"allowedStringValues": null,
"defaultValue": "7200s",
"description": "The interval for sending keepalive probe packets when no data is sent on a connection.",
"explanation": null,
"id": 421,
"maxValue": null,
"minValue": "1s",
"name": "tcp_keepidle",
"needRestart": false,
"readonly": false,
"type": "TIME",
"version": "2.2.76"
},
{
"allowedStringValues": null,
"defaultValue": "90",
"description": "The maximum percentage of system background I/Os.",
"explanation": null,
"id": 147,
"maxValue": "100",
"minValue": "1",
"name": "sys_bkgd_io_high_percentage",
"needRestart": false,
"readonly": false,
"type": "INT",
"version": "1.4.51"
},
{
"allowedStringValues": null,
"defaultValue": "1",
"description": "The caching priority of the Bloom filter.",
"explanation": null,
"id": 8,
"maxValue": null,
"minValue": "1",
"name": "bf_cache_priority",
"needRestart": false,
"readonly": false,
"type": "INT",
"version": "1.4.1"
},
{
"allowedStringValues": null,
"defaultValue": "4G",
"description": "The memory limit for libeasy.",
"explanation": null,
"id": 202,
"maxValue": null,
"minValue": "1G",
"name": "__easy_memory_limit",
"needRestart": false,
"readonly": false,
"type": "CAPACITY",
"version": "2.1.0"
},
{
"allowedStringValues": "EXTERNAL,NORMAL,HIGH",
"defaultValue": "NORMAL",
"description": "The RAID configuration of built-in local disks of the OceanBase database. Do not use this parameter at present.",
"explanation": null,
"id": 288,
"maxValue": null,
"minValue": null,
"name": "redundancy_level",
"needRestart": false,
"readonly": false,
"type": "STRING",
"version": "2.2.0"
},
{
"allowedStringValues": null,
"defaultValue": "1",
"description": "The priority of the statistics cache in the cache system.",
"explanation": null,
"id": 124,
"maxValue": null,
"minValue": "1",
"name": "user_tab_col_stat_cache_priority",
"needRestart": false,
"readonly": false,
"type": "INT",
"version": "1.4.1"
},
{
"allowedStringValues": null,
"defaultValue": "2s",
"description": "The timeout period for internal requests of the cluster.",
"explanation": null,
"id": 99,
"maxValue": null,
"minValue": null,
"name": "rpc_timeout",
"needRestart": false,
"readonly": false,
"type": "TIME",
"version": "1.4.1"
},
{
"allowedStringValues": null,
"defaultValue": "0s",
"description": "The interval of deferred garbage collection for the SSTable after a major compaction.",
"explanation": null,
"id": 319,
"maxValue": "24h",
"minValue": "0s",
"name": "minor_deferred_gc_time",
"needRestart": false,
"readonly": false,
"type": "TIME",
"version": "2.2.20"
},
{
"allowedStringValues": null,
"defaultValue": "20",
"description": "The maximum number of concurrent data migration and replication tasks allowed in the system.",
"explanation": null,
"id": 17,
"maxValue": null,
"minValue": "1",
"name": "data_copy_concurrency",
"needRestart": false,
"readonly": false,
"type": "INT",
"version": "1.4.1"
},
{
"allowedStringValues": null,
"defaultValue": "5",
"description": "The CPU quota for the location cache module.",
"explanation": null,
"id": 55,
"maxValue": "10",
"minValue": "0",
"name": "location_cache_cpu_quota",
"needRestart": false,
"readonly": false,
"type": "DOUBLE",
"version": "1.4.1"
},
{
"allowedStringValues": null,
"defaultValue": "1h",
"description": "The interval of periodic garbage collection for XA transactions.",
"explanation": null,
"id": 407,
"maxValue": null,
"minValue": "1s",
"name": "_xa_gc_interval",
"needRestart": false,
"readonly": false,
"type": "TIME",
"version": "2.2.76"
},
{
"allowedStringValues": null,
"defaultValue": "0",
"description": "The size of the data file. Generally, this parameter does not need to be specified.",
"explanation": null,
"id": 20,
"maxValue": null,
"minValue": "0M",
"name": "datafile_size",
"needRestart": false,
"readonly": false,
"type": "CAPACITY",
"version": "1.4.1"
},
{
"allowedStringValues": null,
"defaultValue": "0",
"description": "The threshold of the last-update time difference of clogs between the leader replica and a follower replica. When this threshold is exceeded, replica recreation is triggered.",
"explanation": null,
"id": 387,
"maxValue": null,
"minValue": null,
"name": "rebuild_replica_data_lag_threshold",
"needRestart": false,
"readonly": false,
"type": "CAPACITY",
"version": "2.2.52"
},
{
"allowedStringValues": null,
"defaultValue": null,
"description": "The destination IP address for backup.",
"explanation": null,
"id": 384,
"maxValue": null,
"minValue": null,
"name": "backup_dest",
"needRestart": false,
"readonly": false,
"type": "STRING",
"version": "2.2.52"
},
{
"allowedStringValues": null,
"defaultValue": "3h",
"description": "The timeout period for major compaction of a zone.",
"explanation": null,
"id": 130,
"maxValue": null,
"minValue": "1s",
"name": "zone_merge_timeout",
"needRestart": false,
"readonly": false,
"type": "TIME",
"version": "1.4.1"
},
{
"allowedStringValues": null,
"defaultValue": "1",
"description": "Specifies whether to enable one-phase commit.",
"explanation": null,
"id": 350,
"maxValue": null,
"minValue": null,
"name": "enable_one_phase_commit",
"needRestart": false,
"readonly": false,
"type": "BOOL",
"version": "2.2.40"
},
{
"allowedStringValues": null,
"defaultValue": "70",
"description": "The threshold of memory used by tenants for triggering a global freeze. This parameter is used with the enable_global_freeze_trigger parameter.",
"explanation": null,
"id": 41,
"maxValue": "99",
"minValue": "1",
"name": "freeze_trigger_percentage",
"needRestart": false,
"readonly": false,
"type": "INT",
"version": "1.4.1"
},
{
"allowedStringValues": null,
"defaultValue": "9s",
"description": "The timeout period of an internal request for obtaining the primary candidate in the automatic follower-to-leader switchover policy.",
"explanation": null,
"id": 42,
"maxValue": "180s",
"minValue": "2s",
"name": "get_leader_candidate_rpc_timeout",
"needRestart": false,
"readonly": false,
"type": "TIME",
"version": "1.4.1"
},
{
"allowedStringValues": null,
"defaultValue": "30MB",
"description": "The maximum I/O bandwidth for system log read/write requests. System logs whose read/write requests require larger I/O bandwidth will be discarded.",
"explanation": null,
"id": 322,
"maxValue": null,
"minValue": null,
"name": "syslog_io_bandwidth_limit",
"needRestart": false,
"readonly": false,
"type": "CAPACITY",
"version": "2.2.20"
}
]
},
"duration": 41,
"server": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2021-09-05T23:03:28.324+08:00",
"traceId": "b368edf91dd148eb"
}