查询租户详情 - 云平台 OCP V4.2.1

查询租户详情

更新时间：2025-08-05 14:13:23

编辑

功能说明

查询指定租户详情。

调用说明

接口约束

调用者需要具备指定集群的读权限。

请求路径

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

请求参数

path：

参数	类型	必选	示例值	描述
id	Long	是	1	目标租户所属集群的 ID。
tenantId	Long	是	5	目标租户的 ID。

返回结果

基础数据结构

参数	类型	说明
data	Object	租户详情，详情参见租户详情数据结构。
successful	Boolean	请求是否成功。
timestamp	Datetime	服务端完成请求的时间戳。
duration	Integer	服务端处理请求的时间（毫秒）。
status	Integer	符合 HTTP Status 规范的编码。
traceId	String	请求的 Trace ID，用于排查问题。
server	String	响应请求的服务端的地址。

租户详情数据结构

参数	类型	说明
id	Long	租户的 ID。
name	String	租户的名称。
clusterName	String	租户所属集群的名称。
clusterId	Integer	租户所属集群在 OCP 端的 ID。
obClusterId	Integer	租户所属集群在 OceanBase 端的 ID。
clusterType	String	租户所属集群的类型，取值范围： PRIMARY：主集群 STANDBY：备集群
syncStatus	Enum	主备同步状态，取值范围： VALID：有效状态 DISABLED：禁止同步数据状态 DISABLED_WITH_READ_ONLY：只读状态 SYNCHRONIZING：同步中（OceanBase 侧当前没有该状态） UNKNOWN：未知状态
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：日常切换。 DELETING：删除中。
locked	Boolean	租户是否处于锁定状态。
readonly	Boolean	租户是否处于只读状态。
obVersion	String	租户所属集群的 OceanBase 版本。
description	String	租户的描述信息。
charset	String	字符集。
collation	String	排序规则。
zones	Array	TenantZone 列表，详情参见 TenantZone 数据结构。
whitelist	String	白名单。

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/8/tenants/9

返回示例

{
  "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
        },
        "units": [
          {
            "id": 1,
            "resourcePoolId": 1,
            "serverId": 12000001,
            "serverIp": "xxx.xxx.xxx.xxx",
            "serverPort": 2882,
            "status": "ACTIVE",
            "zoneName": "zone1"
          }
        ]
      }
    ]
  },
  "duration": 476,
  "server": "a83ad33525",
  "status": 200,
  "successful": true,
  "timestamp": "2021-09-06T00:47:21.093+08:00",
  "traceId": "0b10e088732d432e"
}