--- title: "查询 OBProxy 参数描述信息 - 云平台 OCP V4.3.0 | OceanBase 文档中心" description: 查询 OBProxy 参数描述信息 功能说明 查询 OBProxy 参数元数据。 调用说明 接口约束 调用者需要通过 OCP 应用服务鉴权。 请求路径 GET /api/v2/obproxy/parameterInfo 请求参数 body： 参数 类型 必选 示例值 描述 name String 否 rootserv… --- 切换语言 - 中文站 - 简体中文 - International - English - 日本站 - 日本語 文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*lJTmRZ61jSUAAAAAAAAAAAAADiGDAQ/original) 云平台 OCPV 4.3.0 # 查询 OBProxy 参数描述信息 更新时间：2026-04-14 11:55:54 [编辑](https://github.com/oceanbase/ocp-doc/edit/V4.3.0/zh-CN/1900.reference-guide/200.api-reference/800.obproxy-management/1300.query-the-metadata-of-an-obproxy-parameter.md) ## 功能说明 查询 OBProxy 参数元数据。 ## 调用说明 ### 接口约束 调用者需要通过 OCP 应用服务鉴权。 ### 请求路径 `GET /api/v2/obproxy/parameterInfo` ### 请求参数 **body：** | 参数 | 类型 | 必选 | 示例值 | 描述 | | --- | --- | --- | --- | --- | | name | String | 否 | rootservice_list | 具体参数名。 | | version | String | 否 | 1.9.1 | OBProxy 版本。 | ### 返回结果 **基础数据结构** | 参数 | 类型 | 说明 | | --- | --- | --- | | data | Array | 详情参见 **ParameterInfo 数据结构**。 | | successful | Boolean | 请求是否成功。 | | timestamp | Datetime | 服务端完成请求的时间戳。 | | duration | Integer | 服务端处理请求的时间（毫秒）。 | | status | Integer | 符合 HTTP Status 规范的编码。 | | traceId | String | 请求的 Trace ID，用于排查问题。 | | server | String | 响应请求的应用服务的地址。 | **ParameterInfo 数据结构** | 参数 | 类型 | 说明 | | --- | --- | --- | | id | Long | 参数 ID。 | | name | String | 参数名称。 | | version | String | 版本。 | | type | String | 参数类型，取值范围：- BOOL - CAPACITY - DOUBLE - INT - MOMENT - STRING - STRING_LIST - TIME | | allowedStringValues | String | 参数可选字符串。 | | maxValue | String | 参数最大值。 | | minValue | String | 参数最小值。 | | defaultValue | String | 参数默认值。 | | needRestart | Bool | 是否重启生效。 | | readonly | Bool | 是否只读。 | | description | String | 参数描述。 | | explanation | String | 参数解释。 | ## 示例 ### 请求示例 `GET /api/v2/obproxy/parameterInfo` ### 返回示例 ```json { "data": { "contents": [{ "allowedStringValues": "[0,100]", "defaultValue": "10", "description": "the num of create conn cont, [0, 1000]", "explanation": null, "id": 196, "maxValue": "100", "minValue": "0", "name": "create_conn_cont_num", "needRestart": false, "readonly": false, "type": "INT", "version": "2.1.0" }, { "allowedStringValues": "[0,1000000]", "defaultValue": "100000", "description": "the num of conn in pending list, [0, 100000]", "explanation": null, "id": 197, "maxValue": "1000000", "minValue": "0", "name": "max_pending_num", "needRestart": false, "readonly": false, "type": "INT", "version": "2.1.0" }, { "allowedStringValues": "[0s,1d]", "defaultValue": "5ms", "description": "session_pool_cont_delay_interval, [0s, 1d]", "explanation": null, "id": 198, "maxValue": "1d", "minValue": "0s", "name": "session_pool_cont_delay_interval", "needRestart": false, "readonly": false, "type": "TIME", "version": "2.1.0" }, { "allowedStringValues": "[]", "defaultValue": "false", "description": "if enabled means use_local_session prop", "explanation": null, "id": 199, "maxValue": "true", "minValue": "false", "name": "use_local_session_prop", "needRestart": false, "readonly": false, "type": "BOOL", "version": "2.1.0" }, { "allowedStringValues": "[0,10000]", "defaultValue": "0", "description": "the num of min conn , [0, 100000]", "explanation": null, "id": 200, "maxValue": "10000", "minValue": "0", "name": "session_pool_default_min_conn", "needRestart": false, "readonly": false, "type": "INT", "version": "2.1.0" }, { "allowedStringValues": "[0,100000]", "defaultValue": "20", "description": "the num of max conn , [0, 100000]", "explanation": null, "id": 201, "maxValue": "100000", "minValue": "0", "name": "session_pool_default_max_conn", "needRestart": false, "readonly": false, "type": "INT", "version": "2.1.0" }, { "allowedStringValues": "[0s,1d]", "defaultValue": "1800s", "description": "session_pool_default_idle_timeout, [0s, 1d]", "explanation": null, "id": 202, "maxValue": "1d", "minValue": "0s", "name": "session_pool_default_idle_timeout", "needRestart": false, "readonly": false, "type": "TIME", "version": "2.1.0" }, { "allowedStringValues": "[0ms,2s]", "defaultValue": "500ms", "description": "session_pool_default_blocking_timeout, [0ms, 2s]", "explanation": null, "id": 203, "maxValue": "2s", "minValue": "0ms", "name": "session_pool_default_blocking_timeout", "needRestart": false, "readonly": false, "type": "TIME", "version": "2.1.0" }, { "allowedStringValues": "[]", "defaultValue": "false", "description": "session_pool_default_prefill", "explanation": null, "id": 204, "maxValue": "true", "minValue": "false", "name": "session_pool_default_prefill", "needRestart": false, "readonly": false, "type": "BOOL", "version": "2.1.0" }, { "allowedStringValues": "[]", "defaultValue": "true", "description": "if enabled means use beyond trust", "explanation": null, "id": 205, "maxValue": "true", "minValue": "false", "name": "enable_beyond_trust", "needRestart": false, "readonly": false, "type": "BOOL", "version": "2.1.0" }] }, "duration": 9, "server": "a83ad33525", "status": 200, "successful": true, "timestamp": "2021-09-03T17:11:46.53+08:00", "traceId": "ad3d6adcb291445f" } ``` 上一篇 下一篇 ![有帮助](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) 咨询热线