---
title: "查询 OBProxy 集群参数 | OceanBase 文档中心"
description: "查询 OBProxy 集群参数 功能说明 查询 OBProxy 集群参数设置 调用说明 接口约束 调用者需要通过 OCP 应用服务鉴权。 请求路径 GET /api/v2/obproxy/clusters/{id}/parameters 请求参数 参数 类型 必选 示例值 描述 id Long 是 1 OBProxy…"
---
切换语言

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

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

# 查询 OBProxy 集群参数

更新时间：2023-08-10 11:45:58

## 功能说明

查询 OBProxy 集群参数设置

## 调用说明

### 接口约束

调用者需要通过 OCP 应用服务鉴权。

### 请求路径

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

### 请求参数

| 参数 | 类型 | 必选 | 示例值 | 描述 |
| --- | --- | --- | --- | --- |
| id | Long | 是 | 1 | OBProxy 集群 ID |

### 返回结果

基础数据结构

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

ObproxyClusterParameter 数据结构

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| name | String | 参数名称 |
| description | String | 参数描述 |
| needReboot | Bool | 是否需要重启 |
| values | Array | ObproxyParameterValue 数组 |

ObproxyParameterValue 数据结构

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| value | String | 参数值 |
| obproxies | Array | OBProxy 列表 |

## 示例

### 请求示例

`GET /api/v2/obproxy/clusters/3/parameters`

### 返回示例

```unknow
{
        "data": {
                "contents": [{
                        "description": "proxy info check task interval, [1s, 1h]",
                        "name": "proxy_info_check_interval",
                        "needReboot": false,
                        "valueString": "60s",
                        "values": [{
                                "obproxies": ["xxx.xxx.xxx.xxx"],
                                "value": "60s"
                        }]
                }, {
                        "description": "specifies the current level of logging: DEBUG, TRACE, INFO, WARN, USER_ERR, ERROR",
                        "name": "monitor_log_level",
                        "needReboot": false,
                        "valueString": "INFO",
                        "values": [{
                                "obproxies": ["xxx.xxx.xxx.xxx"],
                                "value": "INFO"
                        }]
                }, {
                        "description": "sock param, packet mark out, [0, 1]",
                        "name": "sock_packet_mark_out",
                        "needReboot": false,
                        "valueString": "0",
                        "values": [{
                                "obproxies": ["xxx.xxx.xxx.xxx"],
                                "value": "0"
                        }]
                }, {
                        "description": "enable net and route prometheus merics or not",
                        "name": "enable_extra_prometheus_metric",
                        "needReboot": false,
                        "valueString": "False",
                        "values": [{
                                "obproxies": ["xxx.xxx.xxx.xxx"],
                                "value": "False"
                        }]
                }, {
                        "description": "epoll_wait timeout for net events, [0, +∞], if set a value <= 0, proxy treat it as 0",
                        "name": "net_config_poll_timeout",
                        "needReboot": false,
                        "valueString": "1ms",
                        "values": [{
                                "obproxies": ["xxx.xxx.xxx.xxx"],
                                "value": "1ms"
                        }]
                }, {
                        "description": "meta table username, format'user@tenant#cluster'",
                        "name": "json_config_meta_table_user",
                        "needReboot": true,
                        "valueString": "",
                        "values": [{
                                "obproxies": ["xxx.xxx.xxx.xxx"],
                                "value": ""
                        }]
                }, {
                        "description": "net accept threads num, [0, 8]",
                        "name": "net_accept_threads",
                        "needReboot": true,
                        "valueString": "2",
                        "values": [{
                                "obproxies": ["xxx.xxx.xxx.xxx"],
                                "value": "2"
                        }]
                }, {
                        "description": "default hot upgrade failure retries, proxy will stop handle hot_upgrade command after such retries, [1, 20]",
                        "name": "hot_upgrade_failure_retries",
                        "needReboot": false,
                        "valueString": "5",
                        "values": [{
                                "obproxies": ["xxx.xxx.xxx.xxx"],
                                "value": "5"
                        }]
                }, {
                        "description": "if client connections reach throttle, true is that new connection will be accepted, and eliminate lru client connection, false is that new connection will disconnect, and err packet will be returned",
                        "name": "enable_client_connection_lru_disconnect",
                        "needReboot": false,
                        "valueString": "False",
                        "values": [{
                                "obproxies": ["xxx.xxx.xxx.xxx"],
                                "value": "False"
                        }]
                }, {
                        "description": "tcp keepalive idle time, unit is second, 0 means use default value by kernel",
                        "name": "server_tcp_keepidle",
                        "needReboot": false,
                        "valueString": "0",
                        "values": [{
                                "obproxies": ["xxx.xxx.xxx.xxx"],
                                "value": "0"
                        }]
                }]
        },
        "duration": 21,
        "server": "a83ad33525",
        "status": 200,
        "successful": true,
        "timestamp": "2021-09-03T17:45:34.409+08:00",
        "traceId": "1e538d4c421a4483"
}

```

 上一篇 下一篇 ![有帮助](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) 咨询热线