查询租户 Unit 列表

更新时间：2026-04-14 11:55:54

编辑

功能说明

查询租户的 Unit 列表。

调用说明

接口约束

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

请求路径

GET /api/v2/ob/cluster/{id}/tenants/{tenantId}/units

请求参数

path：

参数	类型	必选	示例值	描述
id	Long	是	1000001	目标租户所属集群在 OCP 端的集群 ID。
tenantId	Long	是	1000005	目标租户在 OCP 端的租户 ID。

body：

参数	类型	必选	示例值	描述
zoneName	String	否	zone1	Zone 名称。

返回结果

基础数据结构

参数	类型	说明
data	Object	请求的业务数据。
├─ contents	Array	Unit 的数据，详情参见 Unit 数据结构。
├─ page	Object	分页信息。
├─ totalElements	Integer	总记录数。
├─ totalPage	Integer	总页数。
├─ number	Integer	当前页码。
├─ size	Integer	当前页大小。
successful	Boolean	请求是否成功。
timestamp	Datetime	服务端完成请求的时间戳。
duration	Integer	服务端处理请求的时间（毫秒）。
status	Integer	符合 HTTP Status 规范的编码。
traceId	String	请求的 Trace ID，用于排查问题。
server	String	响应请求的服务端的地址。

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 状态。

示例

请求示例

查询 ID 为 1000001 的集群下的所有租户。

GET /api/v2/ob/clusters/1000001/tenants/1000005/units

返回示例

{
    "data": {
        "contents": [
            {
                "id": 1,
                "resourcePoolId": 1,
                "serverId": 12000001,
                "serverIp": "xxx.xxx.xxx.xxx",
                "serverPort": 2882,
                "status": "ACTIVE",
                "zoneName": "zone1"
            }
        ]
    },
    "duration": 109,
    "server": "a83ad33525",
    "status": 200,
    "successful": true,
    "timestamp": "2021-09-06T01:14:54.903+08:00",
    "traceId": "8f0c78a65a4f49b0"
}