---
title: "获取 OceanBase 集群参数列表 | OceanBase 文档中心"
description: 获取 OceanBase 集群参数列表 功能说明 该接口用于获取目标 OceanBase 集群的参数列表。 调用说明 接口约束 调用者需至少具备对目标 OceanBase 集群的只读权限。 关于调用者的权限，详情可参见 安全概述 。 调用者需要通过 OCP 应用服务鉴权。 请求路径 GET /api/v2/ob/cl…
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*lJTmRZ61jSUAAAAAAAAAAAAADiGDAQ/original) 云平台 OCPV 4.0.3 企业版

# 获取 OceanBase 集群参数列表

更新时间：2023-08-16 15:51:32

## 功能说明

该接口用于获取目标 OceanBase 集群的参数列表。

## 调用说明

### 接口约束

- 调用者需至少具备对目标 OceanBase 集群的只读权限。

  关于调用者的权限，详情可参见 [安全概述](https://www.oceanbase.com/docs/enterprise-oceanbase-ocp-cn-10000000001538756)。
 - 调用者需要通过 OCP 应用服务鉴权。

### 请求路径

`GET /api/v2/ob/clusters/{id}/parameters`

**path**

| 参数 | 类型 | 必选 | 示例值 | 描述 |
| --- | --- | --- | --- | --- |
| id | Integer | 是 | 100 | 目标 OceanBase 集群的 ID。 |

### 返回结果

**基础数据结构**

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| data | Array | ClusterParameter 列表 |
| successful | Boolean | 请求是否成功。 |
| timestamp | Datetime | 服务端完成请求的时间戳。 |
| duration | Integer | 服务端处理请求的时间（毫秒）。 |
| status | Integer | 符合 HTTP Status 规范的编码。 |
| traceId | String | 请求的 Trace ID，用于排查问题。 |
| server | String | 响应请求的应用服务的地址。 |

**ClusterParameter 数据结构**

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| name | String | 参数名称。 |
| section | String | 参数分类。 |
| defaultValue | String | 默认值。 |
| valueRange | Object | ValueRange 数据结构。 |
| currentValue | Object | ClusterParameterValue 数据结构。 |
| needRestart | Boolean | 是否需要重启。 |
| readonly | Boolean | 是否只读。 |
| description | String | 参数描述。 |

**ValueRange 数据结构**

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| type | String | 参数类型。 |
| allowedValues | String | 允许的值列表。 |
| maxValue | String | 参数最大值。 |
| minValue | String | 参数最小值。 |

**ClusterParameterValue 数据结构**

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| values | Array | 值列表。 |
| valueToServers | Map | OBServer 值列表。 |
| obParameters | Array | ObParameter 数据结构。 |

**ObParameter 数据结构**

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| zone | String | Zone 名称。 |
| svrIp | String | OBServer 节点的 IP。 |
| svrPort | Integer | OBServer 节点端口。 |
| name | String | 参数名。 |
| value | String | 参数值。 |

## 示例

### 请求示例

`GET /api/v2/ob/clusters/100/parameters`

### 返回示例

```unknow
{
  "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": "关闭一个非活跃连接之前的最大重试次数",
        "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": "前后两次探测之间的时间间隔",
        "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": "设置连接上如果没有数据发送的话，多久后发送keepalive探测分组",
        "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": "启用或关闭 TCP Keepalive 功能",
        "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": "配置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": "控制内存大页的行为,\"true\"表示在操作系统开启内存大页并且有空闲大页时，数据库总是申请内存大页，否则申请普通内存页, \"false\"表示数据库不使用大页, \"only\"表示数据库总是分配大页",
        "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": "自动删除过期的备份",
        "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": "用户显式指定建议哪个地域执行备份",
        "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": "恢复窗口大小",
        "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": "日志归档缓存大小配置",
        "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": "单个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": "日志归档并发度",
        "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": "恢复日志的并发度",
        "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": "日志归档开关",
        "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": "集群备份的总带宽限制",
        "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": "observer备份基线的并发度",
        "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": "日志备份的参数",
        "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": "备份的目标地址",
        "name": "backup_dest",
        "needRestart": false,
        "readonly": false,
        "section": "OBSERVER",
        "valueRange": {
          "allowedValues": null,
          "maxValue": null,
          "minValue": null,
          "type": "STRING"
        }
      }
    ]
  },
  "duration": 144,
  "server": "a83ad33525",
  "status": 200,
  "successful": true,
  "timestamp": "2021-09-05T23:19:50.24+08:00",
  "traceId": "6d075465e6ba4d07"
}

```

 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线