Description
You can call this operation to query parameters of an OceanBase cluster.
Call description
Prerequisites
You have the Read-only permission on the OceanBase cluster.
For more information about the permissions, see Security overview.
You have passed the authentication for the 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 OceanBase cluster. |
Response parameters
Basic data structure
| Parameter | Type | Description |
|---|---|---|
| data | Array | The ClusterParameter 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 ClusterParameter
| Parameter | Type | Description |
|---|---|---|
| name | String | The name of the parameter. |
| section | String | The type of the parameter. |
| defaultValue | String | The default value of the parameter. |
| valueRange | Object | The data structure of valueRange. |
| currentValue | Object | The data structure of ClusterParameterValue. |
| 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. |
Data structure of valueRange
| Parameter | Type | Description |
|---|---|---|
| type | String | The 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. |
| valueToServers | Map | The mapping between values and OBServers. |
| obParameters | Array | The 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. |
| svrPort | Integer | The port number of the OBServer. |
| 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": "ilog_index_expire_time",
"svrIp": "xxx.xxx.xxx.1",
"svrPort": 2882,
"svrType": "observer",
"value": "7d",
"zone": "zone1"
},
{
"name": "ilog_index_expire_time",
"svrIp": "xxx.xxx.xxx.2",
"svrPort": 2882,
"svrType": "observer",
"value": "7d",
"zone": "zone2"
}
],
"singleValueInCluster": true,
"valueToServers": {
"7d": [
"xxx.xxx.xxx.1:2882",
"xxx.xxx.xxx.2:2882"
]
},
"values": [
"7d"
]
},
"name": "ilog_index_expire_time"
},
{
"currentValue": {
"obParameters": [
{
"name": "tcp_keepcnt",
"svrIp": "xxx.xxx.xxx.1",
"svrPort": 2882,
"svrType": "observer",
"value": "10",
"zone": "zone1"
},
{
"name": "tcp_keepcnt",
"svrIp": "xxx.xxx.xxx.2",
"svrPort": 2882,
"svrType": "observer",
"value": "10",
"zone": "zone2"
}
],
"singleValueInCluster": true,
"valueToServers": {
"10": [
"xxx.xxx.xxx.1:2882",
"xxx.xxx.xxx.2:2882"
]
},
"values": [
"10"
]
},
"defaultValue": "",
"description": "The maximum number of retries before terminating an inactive connection.",
"name": "tcp_keepcnt",
"needRestart": false,
"readonly": false,
"section": "OBSERVER",
"valueRange": {
"allowedValues": null,
"maxValue": null,
"minValue": "1",
"type": "INT"
}
},
{
"currentValue": {
"obParameters": [
{
"name": "tcp_keepintvl",
"svrIp": "xxx.xxx.xxx.1",
"svrPort": 2882,
"svrType": "observer",
"value": "6s",
"zone": "zone1"
},
{
"name": "tcp_keepintvl",
"svrIp": "xxx.xxx.xxx.2",
"svrPort": 2882,
"svrType": "observer",
"value": "6s",
"zone": "zone2"
}
],
"singleValueInCluster": true,
"valueToServers": {
"6s": [
"xxx.xxx.xxx.1:2882",
"xxx.xxx.xxx.2:2882"
]
},
"values": [
"6s"
]
},
"defaultValue": "",
"description": "The interval between two probes.",
"name": "tcp_keepintvl",
"needRestart": false,
"readonly": false,
"section": "OBSERVER",
"valueRange": {
"allowedValues": null,
"maxValue": null,
"minValue": "1s",
"type": "TIME"
}
},
{
"currentValue": {
"obParameters": [
{
"name": "tcp_keepidle",
"svrIp": "xxx.xxx.xxx.1",
"svrPort": 2882,
"svrType": "observer",
"value": "7200s",
"zone": "zone1"
},
{
"name": "tcp_keepidle",
"svrIp": "xxx.xxx.xxx.2",
"svrPort": 2882,
"svrType": "observer",
"value": "7200s",
"zone": "zone2"
}
],
"singleValueInCluster": true,
"valueToServers": {
"7200s": [
"xxx.xxx.xxx.1:2882",
"xxx.xxx.xxx.2:2882"
]
},
"values": [
"7200s"
]
},
"defaultValue": "",
"description": "The interval for sending keepalive probe packets when no data is sent on a connection.",
"name": "tcp_keepidle",
"needRestart": false,
"readonly": false,
"section": "OBSERVER",
"valueRange": {
"allowedValues": null,
"maxValue": null,
"minValue": "1s",
"type": "TIME"
}
},
{
"currentValue": {
"obParameters": [
{
"name": "enable_tcp_keepalive",
"svrIp": "xxx.xxx.xxx.1",
"svrPort": 2882,
"svrType": "observer",
"value": "True",
"zone": "zone1"
},
{
"name": "enable_tcp_keepalive",
"svrIp": "xxx.xxx.xxx.2",
"svrPort": 2882,
"svrType": "observer",
"value": "True",
"zone": "zone2"
}
],
"singleValueInCluster": true,
"valueToServers": {
"True": [
"xxx.xxx.xxx.1:2882",
"xxx.xxx.xxx.2:2882"
]
},
"values": [
"True"
]
},
"defaultValue": "FALSE",
"description": "Indicates whether TCP keepalive was enabled.",
"name": "enable_tcp_keepalive",
"needRestart": false,
"readonly": false,
"section": "OBSERVER",
"valueRange": {
"allowedValues": "TRUE,FALSE",
"maxValue": null,
"minValue": null,
"type": "ENUM"
}
},
{
"currentValue": {
"obParameters": [
{
"name": "ssl_external_kms_info",
"svrIp": "xxx.xxx.xxx.1",
"svrPort": 2882,
"svrType": "observer",
"value": "",
"zone": "zone1"
},
{
"name": "ssl_external_kms_info",
"svrIp": "xxx.xxx.xxx.2",
"svrPort": 2882,
"svrType": "observer",
"value": "",
"zone": "zone2"
}
],
"singleValueInCluster": true,
"valueToServers": {
"": [
"xxx.xxx.xxx.1:2882",
"xxx.xxx.xxx.2:2882"
]
},
"values": [
""
]
},
"defaultValue": "",
"description": "The Key Management Service (KMS) information for SSL.",
"name": "ssl_external_kms_info",
"needRestart": false,
"readonly": false,
"section": "OBSERVER",
"valueRange": {
"allowedValues": null,
"maxValue": null,
"minValue": null,
"type": "STRING"
}
},
{
"currentValue": {
"obParameters": [
{
"name": "use_large_pages",
"svrIp": "xxx.xxx.xxx.1",
"svrPort": 2882,
"svrType": "observer",
"value": "false",
"zone": "zone1"
},
{
"name": "use_large_pages",
"svrIp": "xxx.xxx.xxx.2",
"svrPort": 2882,
"svrType": "observer",
"value": "false",
"zone": "zone2"
}
],
"singleValueInCluster": true,
"valueToServers": {
"false": [
"xxx.xxx.xxx.1:2882",
"xxx.xxx.xxx.2:2882"
]
},
"values": [
"false"
]
},
"defaultValue": "",
"description": "Indicates whether large memory pages were used. Valid values: true, false, and only. true indicates that the database always requests large memory pages when large memory pages are enabled for the operating system and idle large memory pages are available. Otherwise, the database requests common memory pages. false indicates that the database does not use large memory pages. only indicates that the database always allocates large memory pages.",
"name": "use_large_pages",
"needRestart": true,
"readonly": false,
"section": "OBSERVER",
"valueRange": {
"allowedValues": null,
"maxValue": null,
"minValue": null,
"type": "STRING"
}
},
{
"currentValue": {
"obParameters": [
{
"name": "auto_delete_expired_backup",
"svrIp": "xxx.xxx.xxx.1",
"svrPort": 2882,
"svrType": "observer",
"value": "False",
"zone": "zone1"
},
{
"name": "auto_delete_expired_backup",
"svrIp": "xxx.xxx.xxx.2",
"svrPort": 2882,
"svrType": "observer",
"value": "False",
"zone": "zone2"
}
],
"singleValueInCluster": true,
"valueToServers": {
"False": [
"xxx.xxx.xxx.1:2882",
"xxx.xxx.xxx.2:2882"
]
},
"values": [
"False"
]
},
"defaultValue": "FALSE",
"description": "Indicates whether expired backup data was automatically deleted.",
"name": "auto_delete_expired_backup",
"needRestart": false,
"readonly": false,
"section": "OBSERVER",
"valueRange": {
"allowedValues": "TRUE,FALSE",
"maxValue": null,
"minValue": null,
"type": "ENUM"
}
},
{
"currentValue": {
"obParameters": [
{
"name": "backup_region",
"svrIp": "xxx.xxx.xxx.1",
"svrPort": 2882,
"svrType": "observer",
"value": "",
"zone": "zone1"
},
{
"name": "backup_region",
"svrIp": "xxx.xxx.xxx.2",
"svrPort": 2882,
"svrType": "observer",
"value": "",
"zone": "zone2"
}
],
"singleValueInCluster": true,
"valueToServers": {
"": [
"xxx.xxx.xxx.1:2882",
"xxx.xxx.xxx.2:2882"
]
},
"values": [
""
]
},
"defaultValue": "",
"description": "The target region for backup.",
"name": "backup_region",
"needRestart": false,
"readonly": false,
"section": "OBSERVER",
"valueRange": {
"allowedValues": null,
"maxValue": null,
"minValue": null,
"type": "STRING"
}
},
{
"currentValue": {
"obParameters": [
{
"name": "backup_recovery_window",
"svrIp": "xxx.xxx.xxx.1",
"svrPort": 2882,
"svrType": "observer",
"value": "0",
"zone": "zone1"
},
{
"name": "backup_recovery_window",
"svrIp": "xxx.xxx.xxx.2",
"svrPort": 2882,
"svrType": "observer",
"value": "0",
"zone": "zone2"
}
],
"singleValueInCluster": true,
"valueToServers": {
"0": [
"xxx.xxx.xxx.1:2882",
"xxx.xxx.xxx.2:2882"
]
},
"values": [
"0"
]
},
"defaultValue": "",
"description": "The size of the recovery window.",
"name": "backup_recovery_window",
"needRestart": false,
"readonly": false,
"section": "OBSERVER",
"valueRange": {
"allowedValues": null,
"maxValue": null,
"minValue": "0",
"type": "TIME"
}
},
{
"currentValue": {
"obParameters": [
{
"name": "log_archive_batch_buffer_limit",
"svrIp": "xxx.xxx.xxx.1",
"svrPort": 2882,
"svrType": "observer",
"value": "1G",
"zone": "zone1"
},
{
"name": "log_archive_batch_buffer_limit",
"svrIp": "xxx.xxx.xxx.2",
"svrPort": 2882,
"svrType": "observer",
"value": "1G",
"zone": "zone2"
}
],
"singleValueInCluster": true,
"valueToServers": {
"1G": [
"xxx.xxx.xxx.1:2882",
"xxx.xxx.xxx.2:2882"
]
},
"values": [
"1G"
]
},
"defaultValue": "",
"description": "The size of the log archiving cache.",
"name": "log_archive_batch_buffer_limit",
"needRestart": false,
"readonly": false,
"section": "OBSERVER",
"valueRange": {
"allowedValues": null,
"maxValue": null,
"minValue": "4M",
"type": "CAPACITY"
}
},
{
"currentValue": {
"obParameters": [
{
"name": "log_archive_checkpoint_interval",
"svrIp": "xxx.xxx.xxx.1",
"svrPort": 2882,
"svrType": "observer",
"value": "120s",
"zone": "zone1"
},
{
"name": "log_archive_checkpoint_interval",
"svrIp": "xxx.xxx.xxx.2",
"svrPort": 2882,
"svrType": "observer",
"value": "120s",
"zone": "zone2"
}
],
"singleValueInCluster": true,
"valueToServers": {
"120s": [
"xxx.xxx.xxx.1:2882",
"xxx.xxx.xxx.2:2882"
]
},
"values": [
"120s"
]
},
"defaultValue": "",
"description": "The interval for generating log archive checkpoints for cold partitions during physical backup of a single OBServer.",
"name": "log_archive_checkpoint_interval",
"needRestart": false,
"readonly": false,
"section": "OBSERVER",
"valueRange": {
"allowedValues": null,
"maxValue": "1h",
"minValue": "5s",
"type": "TIME"
}
},
{
"currentValue": {
"obParameters": [
{
"name": "log_archive_concurrency",
"svrIp": "xxx.xxx.xxx.1",
"svrPort": 2882,
"svrType": "observer",
"value": "0",
"zone": "zone1"
},
{
"name": "log_archive_concurrency",
"svrIp": "xxx.xxx.xxx.2",
"svrPort": 2882,
"svrType": "observer",
"value": "0",
"zone": "zone2"
}
],
"singleValueInCluster": true,
"valueToServers": {
"0": [
"xxx.xxx.xxx.1:2882",
"xxx.xxx.xxx.2:2882"
]
},
"values": [
"0"
]
},
"defaultValue": "",
"description": "The number of concurrent log archiving tasks.",
"name": "log_archive_concurrency",
"needRestart": false,
"readonly": false,
"section": "OBSERVER",
"valueRange": {
"allowedValues": null,
"maxValue": null,
"minValue": "0",
"type": "INT"
}
},
{
"currentValue": {
"obParameters": [
{
"name": "log_restore_concurrency",
"svrIp": "xxx.xxx.xxx.1",
"svrPort": 2882,
"svrType": "observer",
"value": "10",
"zone": "zone1"
},
{
"name": "log_restore_concurrency",
"svrIp": "xxx.xxx.xxx.2",
"svrPort": 2882,
"svrType": "observer",
"value": "10",
"zone": "zone2"
}
],
"singleValueInCluster": true,
"valueToServers": {
"10": [
"xxx.xxx.xxx.1:2882",
"xxx.xxx.xxx.2:2882"
]
},
"values": [
"10"
]
},
"defaultValue": "",
"description": "The number of concurrent log recovery tasks.",
"name": "log_restore_concurrency",
"needRestart": false,
"readonly": false,
"section": "OBSERVER",
"valueRange": {
"allowedValues": null,
"maxValue": null,
"minValue": "1",
"type": "INT"
}
},
{
"currentValue": {
"obParameters": [
{
"name": "enable_log_archive",
"svrIp": "xxx.xxx.xxx.1",
"svrPort": 2882,
"svrType": "observer",
"value": "False",
"zone": "zone1"
},
{
"name": "enable_log_archive",
"svrIp": "xxx.xxx.xxx.2",
"svrPort": 2882,
"svrType": "observer",
"value": "False",
"zone": "zone2"
}
],
"singleValueInCluster": true,
"valueToServers": {
"False": [
"xxx.xxx.xxx.1:2882",
"xxx.xxx.xxx.2:2882"
]
},
"values": [
"False"
]
},
"defaultValue": "FALSE",
"description": "Indicates whether log archiving was enabled.",
"name": "enable_log_archive",
"needRestart": false,
"readonly": false,
"section": "OBSERVER",
"valueRange": {
"allowedValues": "TRUE,FALSE",
"maxValue": null,
"minValue": null,
"type": "ENUM"
}
},
{
"currentValue": {
"obParameters": [
{
"name": "backup_net_limit",
"svrIp": "xxx.xxx.xxx.1",
"svrPort": 2882,
"svrType": "observer",
"value": "0M",
"zone": "zone1"
},
{
"name": "backup_net_limit",
"svrIp": "xxx.xxx.xxx.2",
"svrPort": 2882,
"svrType": "observer",
"value": "0M",
"zone": "zone2"
}
],
"singleValueInCluster": true,
"valueToServers": {
"0M": [
"xxx.xxx.xxx.1:2882",
"xxx.xxx.xxx.2:2882"
]
},
"values": [
"0M"
]
},
"defaultValue": "",
"description": "The total bandwidth for cluster backup.",
"name": "backup_net_limit",
"needRestart": false,
"readonly": false,
"section": "OBSERVER",
"valueRange": {
"allowedValues": null,
"maxValue": null,
"minValue": "0M",
"type": "CAPACITY"
}
},
{
"currentValue": {
"obParameters": [
{
"name": "backup_concurrency",
"svrIp": "xxx.xxx.xxx.1",
"svrPort": 2882,
"svrType": "observer",
"value": "0",
"zone": "zone1"
},
{
"name": "backup_concurrency",
"svrIp": "xxx.xxx.xxx.2",
"svrPort": 2882,
"svrType": "observer",
"value": "0",
"zone": "zone2"
}
],
"singleValueInCluster": true,
"valueToServers": {
"0": [
"xxx.xxx.xxx.1:2882",
"xxx.xxx.xxx.2:2882"
]
},
"values": [
"0"
]
},
"defaultValue": "",
"description": "The number of concurrent OBServer baseline data backup tasks.",
"name": "backup_concurrency",
"needRestart": false,
"readonly": false,
"section": "OBSERVER",
"valueRange": {
"allowedValues": null,
"maxValue": "100",
"minValue": "0",
"type": "INT"
}
},
{
"currentValue": {
"obParameters": [
{
"name": "backup_log_archive_option",
"svrIp": "xxx.xxx.xxx.1",
"svrPort": 2882,
"svrType": "observer",
"value": "OPTIONAL",
"zone": "zone1"
},
{
"name": "backup_log_archive_option",
"svrIp": "xxx.xxx.xxx.2",
"svrPort": 2882,
"svrType": "observer",
"value": "OPTIONAL",
"zone": "zone2"
}
],
"singleValueInCluster": true,
"valueToServers": {
"OPTIONAL": [
"xxx.xxx.xxx.1:2882",
"xxx.xxx.xxx.2:2882"
]
},
"values": [
"OPTIONAL"
]
},
"defaultValue": "",
"description": "The parameters of log backup.",
"name": "backup_log_archive_option",
"needRestart": false,
"readonly": false,
"section": "OBSERVER",
"valueRange": {
"allowedValues": null,
"maxValue": null,
"minValue": null,
"type": "STRING"
}
},
{
"currentValue": {
"obParameters": [
{
"name": "backup_dest",
"svrIp": "xxx.xxx.xxx.1",
"svrPort": 2882,
"svrType": "observer",
"value": "",
"zone": "zone1"
},
{
"name": "backup_dest",
"svrIp": "xxx.xxx.xxx.2",
"svrPort": 2882,
"svrType": "observer",
"value": "",
"zone": "zone2"
}
],
"singleValueInCluster": true,
"valueToServers": {
"": [
"xxx.xxx.xxx.1:2882",
"xxx.xxx.xxx.2:2882"
]
},
"values": [
""
]
},
"defaultValue": "",
"description": "The destination IP address for backup.",
"name": "backup_dest",
"needRestart": false,
"readonly": false,
"section": "OBSERVER",
"valueRange": {
"allowedValues": null,
"maxValue": null,
"minValue": null,
"type": "STRING"
}
}
]
},
"duration": 144,
"server": "xxx.xxx.xxx.1",
"status": 200,
"successful": true,
"timestamp": "2021-09-05T23:19:50.24+08:00",
"traceId": "6d075465e6ba4d07"
}
