--- title: "获取 OceanBase 集群参数元数据 | OceanBase 文档中心" description: 获取 OceanBase 集群参数元数据 功能说明 该接口用于获取 OceanBase 集群参数元数据。 调用说明 接口约束 调用者需至少具备对 OceanBase 集群的只读权限。 关于调用者的权限，详情可参见 安全概述 。 调用者需要通过 OCP 应用服务鉴权。 请求路径 GET /api/v2/ob/clust… --- 切换语言 - 中文站 - 简体中文 - 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/parameterInfo` ### 返回结果 **基础数据结构** | 参数 | 类型 | 说明 | | --- | --- | --- | | data | Array | ParameterInfo 列表。 | | successful | Boolean | 请求是否成功。 | | timestamp | Datetime | 服务端完成请求的时间戳。 | | duration | Integer | 服务端处理请求的时间（毫秒）。 | | status | Integer | 符合 HTTP Status 规范的编码。 | | traceId | String | 请求的 Trace Id，用于排查问题。 | | server | String | 响应请求的应用服务的地址。 | **ParameterInfo 数据结构** | 参数 | 类型 | 说明 | | --- | --- | --- | | name | String | 参数名称。 | | version | String | OceanBase 集群的版本。 | | type | String | 参数类型。 取值范围： * BOOL * CAPACITY * DOUBLE * INT * MOMENT * STRING * STRING_LIST * TIME | | allowedStringValues | String | 参数可选字符串。 | | maxValue | String | 参数最大值。 | | minValue | String | 参数最小值。 | | defaultValue | String | 参数默认值。 | | needRestart | Boolean | 是否需要重启。 | | readonly | Boolean | 是否只读。 | | description | String | 参数描述。 | ## 示例 ### 请求示例 `GET /api/v2/ob/clusters/parameterInfo` ### 返回示例 ```unknow { "data": { "contents": [ { "allowedStringValues": null, "defaultValue": "0", "description": "是否记录追踪日志", "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": "基线数据行缓存在缓存系统中的优先级", "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": "当剩余内存小于这个百分比时，触发全局冻结", "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": "指定集群的partition balance策略", "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": "失效socket检测超时时间", "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": "RootService最大内存限制", "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": "通过控制内存分配进度，实现控制写入速度。指定在触发写入限速后，剩余memstore内存分配完所需的时间。", "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": "是否允许新建和修改系统表。主要在系统升级过程中使用。", "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": "合并完成副本数达到该百分比，则认为本轮合并完成调度", "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": "系统内部SQL请求的超时时间", "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": "节点心跳中断多久后认为其被"临时下线"", "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": "是否启用系统日志异步写", "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": "开启oracle租户权限验证", "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": "设置连接上如果没有数据发送的话，多久后发送keepalive探测分组", "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": "系统后台IO最高可以占用IO的百分比", "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": "布隆过滤器占用缓存的优先级", "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": "网络通讯库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": "OB内置本地磁盘RAID特性。暂勿使用", "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": "统计数据缓存在缓存系统中的优先级", "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": "集群内部请求的超时时间", "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": "合并之后SSTable延迟回收间隔", "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": "系统中并发执行的数据迁移复制任务的最大并发数", "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": "位置缓存模块使用的CPU配额", "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": "定期回收XA事务的时间间隔", "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": "数据文件大小。一般不要设置。", "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": "备副本的事务日志和主副本差距超过该阈值时，触发副本重建", "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": "备份的目标地址", "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": "单个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": "是否开启事务提交一阶段优化的功能", "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": "触发全局冻结的租户使用内存阈值。另见enable_global_freeze_trigger。", "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": "自动切主策略获取切主候选者的内部请求超时时间", "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": "系统日志所能占用的磁盘IO带宽上限，超过带宽的系统日志将被丢弃", "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" } ``` 上一篇 下一篇 ![有帮助](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) 咨询热线