Description
You can call this operation to query the parameter metadata of OceanBase clusters.
Call description
Prerequisites
You have the read-only permission on OceanBase clusters.
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/parameterInfo
Response parameters
Basic data structure
| Parameter | Type | Description |
|---|---|---|
| data | Array | For more information, see Data structure of ParameterInfo. |
| 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 ParameterInfo
| Parameter | Type | Description |
|---|---|---|
| name | String | The name of the parameter. |
| version | String | The version of OceanBase clusters. |
| section | String | The category of the parameter. |
| type | String | The data type of the parameter. Valid values: |
| 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: |
| allowedStringValues | String | The allowed string values of the parameter. |
| maxValue | String | The maximum value of the parameter. |
| minValue | String | The minimum value of the parameter. |
| valueRange | Object | The value range of the cluster or tenant parameter. |
| ├─type | String | The type of the value range. |
| ├─allowedValues | String | The allowed value range. This parameter takes effect if type is set to ENUM. Multiple values are separated with commas (,), such as TRUE,FALSE. |
| ├─maxValue | String | The maximum value. |
| ├─minValue | String | The minimum value. |
| defaultValue | String | The default value. |
| 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. |
Examples
Sample request
GET /api/v2/ob/clusters/parameterInfo
Sample response
{
"data": {
"contents": [{
"defaultValue": "FALSE",
"description": "trigger_reuse_table_in_table_mgr",
"editionCompatibleType": "ALL",
"id": 618,
"name": "trigger_reuse_table_in_table_mgr",
"needRestart": false,
"parameterType": "OB_CLUSTER_PARAMETER",
"readonly": false,
"section": "OBSERVER",
"type": "BOOL",
"valueRange": {
"allowedValues": "TRUE,FALSE",
"type": "ENUM"
},
"version": "3.1.0"
},
{
"defaultValue": "0",
"description": "control interval of backup archive log",
"editionCompatibleType": "ALL",
"id": 452,
"maxValue": "24h",
"minValue": "0s",
"name": "backup_log_archive_checkpoint_interval",
"needRestart": false,
"parameterType": "OB_CLUSTER_PARAMETER",
"readonly": false,
"section": "OBSERVER",
"type": "TIME",
"valueRange": {
"maxValue": "24h",
"minValue": "0s",
"type": "TIME"
},
"version": "2.2.76"
},
{
"defaultValue": "8",
"description": "The number of io threads on each disk.",
"editionCompatibleType": "ALL",
"id": 270,
"maxValue": "32",
"minValue": "2",
"name": "disk_io_thread_count",
"needRestart": false,
"parameterType": "OB_CLUSTER_PARAMETER",
"readonly": false,
"section": "OBSERVER",
"type": "INT",
"valueRange": {
"maxValue": "32",
"minValue": "2",
"type": "INT"
},
"version": "2.2.0"
},
{
"defaultValue": "0",
"description": "macro_block_builder_errsim_flag Range: [0,100] in integer",
"editionCompatibleType": "ALL",
"id": 591,
"maxValue": "100",
"minValue": "0",
"name": "macro_block_builder_errsim_flag",
"needRestart": false,
"parameterType": "OB_CLUSTER_PARAMETER",
"readonly": false,
"section": "OBSERVER",
"type": "INT",
"valueRange": {
"maxValue": "100",
"minValue": "0",
"type": "INT"
},
"version": "3.1.0"
},
{
"defaultValue": "10m",
"description": "the time interval between the schedules of the task that checks on the progress of MERGE for each zone. Range: [10s, 60m]",
"editionCompatibleType": "ALL",
"id": 814,
"maxValue": "60m",
"minValue": "10s",
"name": "merger_check_interval",
"needRestart": false,
"parameterType": "OB_TENANT_PARAMETER",
"readonly": false,
"section": "DAILY_MERGE",
"type": "TIME",
"valueRange": {
"maxValue": "60m",
"minValue": "10s",
"type": "TIME"
},
"version": "4.0.0"
},
{
"defaultValue": "AUTO",
"description": "policy used to size SQL working areas (MANUAL/AUTO)",
"editionCompatibleType": "ALL",
"id": 549,
"name": "workarea_size_policy",
"needRestart": false,
"parameterType": "OB_TENANT_PARAMETER",
"readonly": false,
"section": "TENANT",
"type": "STRING",
"valueRange": {
"type": "STRING"
},
"version": "3.0.0"
},
{
"defaultValue": "TRUE",
"description": "when set to false, cgroup will not init; when set to true but cgroup root dir is not ready, print ERROR",
"editionCompatibleType": "ALL",
"id": 794,
"name": "enable_cgroup",
"needRestart": true,
"parameterType": "OB_CLUSTER_PARAMETER",
"readonly": false,
"section": "OBSERVER",
"type": "BOOL",
"valueRange": {
"allowedValues": "TRUE,FALSE",
"type": "ENUM"
},
"version": "4.0.0"
},
{
"defaultValue": "20",
"description": "check cycle of db data.",
"editionCompatibleType": "ALL",
"id": 206,
"maxValue": "360",
"minValue": "0",
"name": "builtin_db_data_verify_cycle",
"needRestart": false,
"parameterType": "OB_CLUSTER_PARAMETER",
"readonly": false,
"section": "OBSERVER",
"type": "INT",
"valueRange": {
"maxValue": "360",
"minValue": "0",
"type": "INT"
},
"version": "2.1.0"
},
{
"defaultValue": "0",
"description": "for test start ts rollback Range: [0,max) in integer",
"editionCompatibleType": "ALL",
"id": 684,
"minValue": "0",
"name": "fake_report_server_tenant_start_ts",
"needRestart": false,
"parameterType": "OB_CLUSTER_PARAMETER",
"readonly": false,
"section": "OBSERVER",
"type": "INT",
"valueRange": {
"minValue": "0",
"type": "INT"
},
"version": "3.1.2"
},
{
"defaultValue": "100",
"description": "the threshold of the size of the mem store when writing_limit will be triggered.",
"editionCompatibleType": "ALL",
"id": 233,
"maxValue": "100",
"minValue": "0",
"name": "write_throttling_trigger_percentage",
"needRestart": false,
"parameterType": "OB_CLUSTER_PARAMETER",
"readonly": false,
"section": "TENANT",
"type": "INT",
"valueRange": {
"maxValue": "100",
"minValue": "0",
"type": "INT"
},
"version": "2.1.11"
},
{
"defaultValue": "FALSE",
"description": "specifies whether add ip:port, time and trace id to user error message.",
"editionCompatibleType": "ALL",
"id": 33,
"name": "enable_rich_error_msg",
"needRestart": false,
"parameterType": "OB_CLUSTER_PARAMETER",
"readonly": false,
"section": "OBSERVER",
"type": "BOOL",
"valueRange": {
"allowedValues": "TRUE,FALSE",
"type": "ENUM"
},
"version": "1.4.1"
},
{
"defaultValue": "FALSE",
"description": "specifies whether or not PL/SQL library units will be compiled for debugging",
"editionCompatibleType": "ALL",
"id": 504,
"name": "plsql_debug",
"needRestart": false,
"parameterType": "OB_TENANT_PARAMETER",
"readonly": false,
"section": "OBSERVER",
"type": "BOOL",
"valueRange": {
"allowedValues": "TRUE,FALSE",
"type": "ENUM"
},
"version": "2.2.77"
},
{
"defaultValue": "4G",
"description": "backup data file size. Range: [512M, 4G] in integer",
"editionCompatibleType": "ALL",
"id": 786,
"maxValue": "4G",
"minValue": "512M",
"name": "backup_data_file_size",
"needRestart": false,
"parameterType": "OB_CLUSTER_PARAMETER",
"readonly": false,
"section": "OBSERVER",
"type": "CAPACITY",
"valueRange": {
"maxValue": "4G",
"minValue": "512M",
"type": "CAPACITY"
},
"version": "4.0.0"
},
{
"defaultValue": "FALSE",
"description": "specifies whether pg test mode is turned on.",
"editionCompatibleType": "ALL",
"id": 274,
"name": "enable_pg_test_mode",
"needRestart": false,
"parameterType": "OB_CLUSTER_PARAMETER",
"readonly": false,
"section": "ROOT_SERVICE",
"type": "BOOL",
"valueRange": {
"allowedValues": "TRUE,FALSE",
"type": "ENUM"
},
"version": "2.2.0"
},
{
"defaultValue": "5",
"description": "the number of vCPUs allocated for the requests regarding location info of the core tables.",
"editionCompatibleType": "ALL",
"id": 55,
"maxValue": "10",
"minValue": "0",
"name": "location_cache_cpu_quota",
"needRestart": false,
"parameterType": "OB_CLUSTER_PARAMETER",
"readonly": false,
"section": "TENANT",
"type": "DOUBLE",
"valueRange": {
"maxValue": "10",
"minValue": "0",
"type": "DOUBLE"
},
"version": "1.4.1"
},
{
"defaultValue": "0",
"description": "the CPU weights of tenant major compaction",
"editionCompatibleType": "ALL",
"id": 748,
"maxValue": "100",
"minValue": "0",
"name": "compaction_low_thread_score",
"needRestart": false,
"parameterType": "OB_TENANT_PARAMETER",
"readonly": false,
"section": "TENANT",
"type": "INT",
"valueRange": {
"maxValue": "100",
"minValue": "0",
"type": "INT"
},
"version": "4.0.0"
},
{
"defaultValue": "256",
"description": "the row number processed by vectorized sql engine within one batch. Range: [0, 65535]",
"editionCompatibleType": "ALL",
"id": 709,
"maxValue": "65535",
"minValue": "0",
"name": "_rowsets_max_rows",
"needRestart": false,
"parameterType": "OB_TENANT_PARAMETER",
"readonly": false,
"section": "TENANT",
"type": "INT",
"valueRange": {
"maxValue": "65535",
"minValue": "0",
"type": "INT"
},
"version": "3.2.0"
},
{
"defaultValue": "FALSE",
"description": "specifies whether to create table as extended rowid mode or not",
"editionCompatibleType": "ALL",
"id": 793,
"name": "default_enable_extended_rowid",
"needRestart": false,
"parameterType": "OB_TENANT_PARAMETER",
"readonly": false,
"section": "OBSERVER",
"type": "BOOL",
"valueRange": {
"allowedValues": "TRUE,FALSE",
"type": "ENUM"
},
"version": "4.0.0"
},
{
"defaultValue": "10",
"description": "index cache priority. Range:[1, )",
"editionCompatibleType": "ALL",
"id": 808,
"minValue": "1",
"name": "index_block_cache_priority",
"needRestart": false,
"parameterType": "OB_CLUSTER_PARAMETER",
"readonly": false,
"section": "CACHE",
"type": "INT",
"valueRange": {
"minValue": "1",
"type": "INT"
},
"version": "4.0.0"
},
{
"defaultValue": "3",
"description": "clog file expired days. Range: [1, 365]",
"editionCompatibleType": "ALL",
"id": 714,
"maxValue": "365",
"minValue": "1",
"name": "clog_expire_days",
"needRestart": false,
"parameterType": "OB_CLUSTER_PARAMETER",
"readonly": false,
"section": "TRANS",
"type": "INT",
"valueRange": {
"maxValue": "365",
"minValue": "1",
"type": "INT"
},
"version": "3.2.0"
},
{
"defaultValue": "50",
"description": "used in calculating the value of MEMSTORE_LIMIT",
"editionCompatibleType": "ALL",
"id": 71,
"maxValue": "99",
"minValue": "1",
"name": "memstore_limit_percentage",
"needRestart": false,
"parameterType": "OB_CLUSTER_PARAMETER",
"readonly": false,
"section": "TENANT",
"type": "INT",
"valueRange": {
"maxValue": "99",
"minValue": "1",
"type": "INT"
},
"version": "1.4.1"
},
{
"defaultValue": "TRUE",
"description": "specifies whether partition leadership auto-switch is turned on.",
"editionCompatibleType": "ALL",
"id": 25,
"name": "enable_auto_leader_switch",
"needRestart": false,
"parameterType": "OB_CLUSTER_PARAMETER",
"readonly": false,
"section": "ROOT_SERVICE",
"type": "BOOL",
"valueRange": {
"allowedValues": "TRUE,FALSE",
"type": "ENUM"
},
"version": "1.4.1"
},
{
"defaultValue": "10000000",
"description": "the maximum number of the records in SQL audit virtual table. (dont use now)",
"editionCompatibleType": "ALL",
"id": 107,
"minValue": "10000",
"name": "sql_audit_queue_size",
"needRestart": false,
"parameterType": "OB_CLUSTER_PARAMETER",
"readonly": false,
"section": "OBSERVER",
"type": "INT",
"valueRange": {
"minValue": "10000",
"type": "INT"
},
"version": "1.4.1"
},
{
"defaultValue": "None",
"description": "enables or disables database auditing, support NONE;OS;DB;DB,EXTENDED;DB_EXTENDED",
"editionCompatibleType": "ALL",
"id": 352,
"name": "audit_trail",
"needRestart": false,
"parameterType": "OB_TENANT_PARAMETER",
"readonly": false,
"section": "OBSERVER",
"type": "STRING",
"valueRange": {
"type": "STRING"
},
"version": "2.2.30"
},
{
"defaultValue": "FALSE",
"description": "Enable or disable QUERY_RESPONSE_TIME statistics collecting The default value is False. Value: TRUE: turned on FALSE: turned off",
"editionCompatibleType": "ALL",
"id": 823,
"name": "query_response_time_stats",
"needRestart": false,
"parameterType": "OB_TENANT_PARAMETER",
"readonly": false,
"section": "TENANT",
"type": "BOOL",
"valueRange": {
"allowedValues": "TRUE,FALSE",
"type": "ENUM"
},
"version": "4.0.0"
},
{
"defaultValue": "4",
"description": "max allowed concurrency for 1 CPU quota. Range: [1,10]",
"editionCompatibleType": "ALL",
"id": 789,
"maxValue": "10",
"minValue": "1",
"name": "cpu_quota_concurrency",
"needRestart": false,
"parameterType": "OB_TENANT_PARAMETER",
"readonly": false,
"section": "TENANT",
"type": "DOUBLE",
"valueRange": {
"maxValue": "10",
"minValue": "1",
"type": "DOUBLE"
},
"version": "4.0.0"
},
{
"defaultValue": "60",
"description": "the threshold of the size of the mem store when writing_limit will be triggered. Rang:(0, 100]. setting 100 means turn off writing limit",
"editionCompatibleType": "ALL",
"id": 841,
"maxValue": "100",
"minValue": "1",
"name": "writing_throttling_trigger_percentage",
"needRestart": false,
"parameterType": "OB_TENANT_PARAMETER",
"readonly": false,
"section": "TRANS",
"type": "INT",
"valueRange": {
"maxValue": "100",
"minValue": "1",
"type": "INT"
},
"version": "4.0.0"
},
{
"defaultValue": "512K",
"description": "the size of routine execution stack Range: [512K, 20M]",
"editionCompatibleType": "ALL",
"id": 831,
"maxValue": "20M",
"minValue": "512K",
"name": "stack_size",
"needRestart": true,
"parameterType": "OB_CLUSTER_PARAMETER",
"readonly": false,
"section": "OBSERVER",
"type": "CAPACITY",
"valueRange": {
"maxValue": "20M",
"minValue": "512K",
"type": "CAPACITY"
},
"version": "4.0.0"
},
{
"defaultValue": "30s",
"description": "warm up duration time for minor freeze.",
"editionCompatibleType": "ALL",
"id": 287,
"maxValue": "60m",
"minValue": "0s",
"name": "minor_warm_up_duration_time",
"needRestart": false,
"parameterType": "OB_CLUSTER_PARAMETER",
"readonly": false,
"section": "OBSERVER",
"type": "TIME",
"valueRange": {
"maxValue": "60m",
"minValue": "0s",
"type": "TIME"
},
"version": "2.2.0"
},
{
"defaultValue": "FALSE",
"description": "mock device touch and delete",
"editionCompatibleType": "ALL",
"id": 596,
"name": "mock_nfs_device_touch",
"needRestart": false,
"parameterType": "OB_CLUSTER_PARAMETER",
"readonly": false,
"section": "OBSERVER",
"type": "BOOL",
"valueRange": {
"allowedValues": "TRUE,FALSE",
"type": "ENUM"
},
"version": "3.1.0"
}]
},
"duration": 92,
"server": "74f95ea2f4",
"status": 200,
"successful": true,
"timestamp": "2025-03-20T14:14:07.381+08:00",
"traceId": "02cc799aca2a3684"
}
