---
title: "获取租户参数列表 | OceanBase 文档中心"
description: "获取租户参数列表 功能说明 获取租户参数列表时使用的接口。 调用说明 接口约束 调用者需要通过 OCP 应用服务鉴权。 请求路径 GET /api/v2/ob/clusters/{id}/tenants/{tenantId}/parameters path 参数 类型 必选 示例值 描述 id Integer 是 1…"
---
切换语言

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

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

# 获取租户参数列表

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

## 功能说明

获取租户参数列表时使用的接口。

## 调用说明

### 接口约束

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

### 请求路径

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

**path**

| 参数 | 类型 | 必选 | 示例值 | 描述 |
| --- | --- | --- | --- | --- |
| id | Integer | 是 | 100 | OceanBase 集群 ID |
| tenantId | Integer | 是 | 200 | 租户 ID |

### 返回结果

基础数据结构

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

TenantParameter 数据结构

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| name | String | 参数名称 |
| compatibleType | String | 兼容类型。 取值范围： * ORACLE * MYSQL |
| readonly | Boolean | 是否只读 |
| defaultValue | String | 默认值 |
| currentValue | String | 当前值 |
| description | String | 参数描述 |
| valueRange | Object | ValueRange 数据结构 |

ValueRange 数据结构

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

## 示例

### 请求示例

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

### 返回示例

```unknow
{
    "data": {
        "contents": [
            {
                "currentValue": "ON",
                "defaultValue": "ON",
                "description": "是否自动提交。",
                "name": "autocommit",
                "readonly": false,
                "valueRange": {
                    "allowedValues": "OFF,ON",
                    "type": "ENUM"
                }
            },
            ......
            ......
            ......
            {
                "currentValue": "ON",
                "defaultValue": "ON",
                "description": "是否允许聚合操作下压。",
                "name": "ob_enable_aggregation_pushdown",
                "readonly": false,
                "valueRange": {
                    "allowedValues": "OFF,ON",
                    "type": "ENUM"
                }
            }
        ]
    },
    "duration": 219,
    "server": "a83ad33525",
    "status": 200,
    "successful": true,
    "timestamp": "2021-09-06T01:49:16.946+08:00",
    "traceId": "00a58024130d474b"
}

```

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