--- title: "查询租户详情 - 云平台 OCP V4.3.3 | OceanBase 文档中心" description: "查询租户详情 功能说明 查询指定租户详情。 调用说明 接口约束 调用者需要具备指定集群的读权限。 请求路径 GET /api/v2/ob/clusters/{id}/tenants/{tenantId} 请求参数 path： 参数 类型 必选 示例值 描述 id Long 是 1000014 目标租户所属集群在 OC…" --- 切换语言 - 中文站 - 简体中文 - International - English - 日本站 - 日本語 文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*lJTmRZ61jSUAAAAAAAAAAAAADiGDAQ/original) 云平台 OCPV 4.3.3 # 查询租户详情 更新时间：2026-04-14 15:16:09 [编辑](https://github.com/oceanbase/ocp-doc/edit/V4.3.3/zh-CN/1900.reference-guide/200.api-reference/600.tenant-management/300.query-tenant-details.md) ## 功能说明 查询指定租户详情。 ## 调用说明 ### 接口约束 调用者需要具备指定集群的读权限。 ### 请求路径 `GET /api/v2/ob/clusters/{id}/tenants/{tenantId}` ### 请求参数 **path：** | 参数 | 类型 | 必选 | 示例值 | 描述 | | --- | --- | --- | --- | --- | | id | Long | 是 | 1000014 | 目标租户所属集群在 OCP 端的集群 ID。 | | tenantId | Long | 是 | 1000007 | 目标租户在 OCP 端的租户 ID。 | ### 返回结果 **基础数据结构** | 参数 | 类型 | 说明 | | --- | --- | --- | | data | Object | 租户详情，详情参见 **租户详情的数据结构**。 | | successful | Boolean | 请求是否成功。 | | timestamp | Datetime | 服务端完成请求的时间戳。 | | duration | Integer | 服务端处理请求的时间（毫秒）。 | | status | Integer | 符合 HTTP Status 规范的编码。 | | traceId | String | 请求的 Trace ID，用于排查问题。 | | server | String | 响应请求的服务端的地址。 | **租户详情数据结构** | 参数 | 类型 | 说明 | | --- | --- | --- | | id | Long | OCP 端的租户 ID 。 | | name | String | 租户的名称。 | | clusterName | String | 租户所属集群的名称。 | | clusterId | Long | 租户所属集群在 OCP 端的集群 ID。 | | obClusterId | Long | 租户所属集群在 OceanBase 端的集群 ID。 | | clusterType | String | 租户所属集群的类型，取值范围：- PRIMARY：主集群 - STANDBY：备集群 | | mode | String | 租户的模式，取值范围：- ORACLE：Oracle 模式 - MYSQL：MySQL 模式 | | createTime | Datetime | 租户的创建时间。 | | primaryZone | String | 租户的 Zone 优先级。 | | zoneList | String | 租户的 Zone List。 | | locality | String | 租户的副本分布。 | | status | String | 租户的状态，取值范围：- NORMAL：运行中。 - CREATING：创建中。 - MODIFYING：修改中。 - UNAVAILABLE：不可用。 - RESTORING：恢复中。 - DISCONNECTING：解耦中。 - FAILOVER：容灾切换。 - SWITCHOVER：日常切换。 - OPERATING：运维中。 - CLONING：克隆中。 | | locked | Boolean | 租户是否处于锁定状态。 | | readonly | Boolean | 租户是否处于只读状态。 | | obVersion | String | 租户所属集群的 OceanBase 版本。 | | description | String | 租户的描述信息。 | | charset | String | 字符集。 | | collation | String | 排序规则。 | | zones | Array | TenantZone 列表，详情参见 **TenantZone 数据结构**。 | | whitelist | String | 白名单。 | | loadType | Enum | 负载类型：- EXPRESS_OLTP - COMPLEX_OLTP - HTAP - OLAP - KV | **TenantZone 数据结构** | 参数 | 类型 | 说明 | | --- | --- | --- | | name | String | Zone 名。 | | replicaType | String | 副本类型。 | | resourcePool | Object | 详情参见 **ResourcePool 数据结构**。 | | units | Array | 详情参见 **Unit 数据结构**。 | **ResourcePool 数据结构** | 参数 | 类型 | 说明 | | --- | --- | --- | | id | String | 资源池 ID。 | | name | String | 资源池名称。 | | unitCount | Integer | Unit 个数。 | | unitConfig | Object | 详情参见 **UnitConfig 数据结构**。 | **UnitConfig 数据结构** | 参数 | 类型 | 说明 | | --- | --- | --- | | maxCpuCoreCount | Double | 最大 CPU 个数。 | | minCpuCoreCount | Double | 最小 CPU 个数。 | | maxMemorySize | Integer | 最大内存，单位 GiB。 | | minMemorySize | Integer | 最小内存，单位 GiB。 | **Unit 数据结构** | 参数 | 类型 | 说明 | | --- | --- | --- | | id | Integer | Uint ID。 | | resourcePoolId | Integer | 所属资源池 ID。 | | serverId | Integer | 所属 OBServer 节点 ID。 | | serverIp | String | 所属 OBServer 节点 IP。 | | serverPort | Integer | 所属 OBServer 节点端口。 | | zoneName | String | Zone 名称。 | | status | String | Unit 状态。 | ## 示例 ### 请求示例 `GET /api/v2/ob/clusters/1000014/tenants/1000007` ### 返回示例 ```json { "data": { "charset": "utf8mb4", "clusterId": 12000001, "clusterName": "protoss", "clusterStatus": "RUNNING", "clusterType": "PRIMARY", "collation": "utf8mb4_general_ci", "createTime": "2021-09-02T16:39:57+08:00", "id": 14000001, "locality": "FULL{1}@zone1", "locked": false, "mode": "MYSQL", "name": "sys", "obClusterId": 22, "obTenantId": 1, "obVersion": "3.1.0", "primaryZone": "zone1", "readonly": false, "sqlAuditEnabled": true, "status": "NORMAL", "whitelist": "%", "zoneList": "zone1", "zones": [ { "name": "zone1", "replicaType": "FULL", "resourcePool": { "id": 1, "name": "sys_pool", "unitConfig": { "maxCpuCoreCount": 5.00, "maxMemorySize": 9, "minCpuCoreCount": 2.50, "minMemorySize": 8 }, "unitCount": 1 }, "mode": "MYSQL", "name": "sys", "obClusterId": 1658110665, "obTenantId": 1, "obVersion": "4.2.3.0", "primaryZone": "RANDOM", "readonly": false, "role": "PRIMARY", "status": "NORMAL", "syncStatus": "VALID", "whitelist": "%", "zoneList": "zone2;zone3", "zones": [{ "name": "zone2", "replicaType": "FULL", "resourcePool": { "id": 1004, "name": "pool_sys_zone2_nng", "unitConfig": { "iopsWeight": 1, "logDiskSize": 18, "logDiskSizeByte": 19327352832, "maxCpuCoreCount": 1.50, "maxIops": 0, "maxMemoryByte": 6442450944, "maxMemorySize": 6, "minCpuCoreCount": 1.50, "minIops": 0, "minMemoryByte": 6442450944, "minMemorySize": 6 }, "unitCount": 1, "zoneList": ["zone2"] }, "units": [{ "address": "xxx.xxx.xxx.xxx:2882", "hostId": 1000007, "id": 1003, "obTenantId": 1, "resourcePoolId": 1004, "serverId": 1000053, "serverIp": "xxx.xxx.xxx.xxx", "serverPort": 2882, "status": "ACTIVE", "tenantName": "sys", "zoneName": "zone2" }] }, { "name": "zone3", "replicaType": "FULL", "resourcePool": { "id": 1005, "name": "pool_sys_zone3_efd", "unitConfig": { "iopsWeight": 1, "logDiskSize": 18, "logDiskSizeByte": 19327352832, "maxCpuCoreCount": 1.50, "maxIops": 0, "maxMemoryByte": 6442450944, "maxMemorySize": 6, "minCpuCoreCount": 1.50, "minIops": 0, "minMemoryByte": 6442450944, "minMemorySize": 6 }, "unitCount": 1, "zoneList": ["zone3"] }, "units": [{ "address": "xxx.xxx.xxx.xxx:2882", "hostId": 1000004, "id": 1004, "obTenantId": 1, "resourcePoolId": 1005, "serverId": 1000054, "serverIp": "xxx.xxx.xxx.xxx", "serverPort": 2882, "status": "ACTIVE", "tenantName": "sys", "zoneName": "zone3" }] }] }, "duration": 145, "server": "5e11a5f435", "status": 200, "successful": true, "timestamp": "2025-03-20T10:39:06.195+08:00", "traceId": "5c373efa06c97ac0" } ``` 上一篇 下一篇 ![有帮助](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) 咨询热线