---
title: "list obclusters"
method: GET
path: "/api/v1/obclusters"
tags: ["OBCluster"]
---

# list obclusters

`GET /api/v1/obclusters`

list obclusters

## Response `200`

OK

- object
  - `data` ResponseOBClusterOverview[], required
    - `clusterId` integer, required
    - `clusterName` string, required
    - `createTime` integer, required
    - `deletionProtection` boolean, required
    - `image` string, required
    - `mode` 'NORMAL' | 'STANDALONE' | 'SERVICE', required
    - `name` string, required
    - `namespace` string, required
    - `pvcIndependent` boolean, required
    - `status` string, required
    - `statusDetail` string, required
    - `supportStaticIP` boolean, required
    - `topology` ResponseOBZone[], required
      - `affinities` CommonAffinitySpec[]
        - `key` string, required
        - `operator` string, required — Enum: In, NotIn, Exists, DoesNotExist
        - `preferred` boolean
        - `type` 'NODE' | 'POD' | 'POD_ANTI', required
        - `values` string[]
        - `weight` integer
      - `k8sCluster` string
      - `name` string, required
      - `namespace` string, required
      - `nodeSelector` CommonKVPair[]
        - `key` string, required
        - `value` string, required
      - `observers` ResponseOBServer[]
        - `address` string, required
        - `metrics` ResponseOBMetrics
          - `cpuPercent` integer, required
          - `diskPercent` integer, required
          - `memoryPercent` integer, required
        - `name` string, required
        - `namespace` string, required
        - `nodeIp` string, required
        - `nodeName` string, required
        - `status` string, required
        - `statusDetail` string, required
      - `replicas` integer, required
      - `rootService` string
      - `status` string, required
      - `statusDetail` string, required
      - `tolerations` CommonTolerationSpec[]
        - `effect` string, required — Enum: PreferNoSchedule, NoSchedule, NoExecute
        - `key` string, required
        - `operator` string, required — Enum: Exists, Equal
        - `tolerationSeconds` integer
        - `value` string, required
      - `zone` string, required
    - `uid` string, required
  - `message` string, required
  - `successful` boolean, required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Internal Server Error

## Changes

- **2024-03-14** `649de0f2e535` — 2 info
  - api tag `OBCluster` added
  - api tag `Obcluster` removed
- **2024-02-27** `643ae3c8d824` — 2 info
  - api tag `Obcluster` added
  - api tag `OBCluster` removed

[Change history](https://skmtc.dev/oceanbase/apis/oceanbase-dashboard-api/changes/api/v1/obclusters/get.md)

---

[API](https://skmtc.dev/oceanbase/apis/oceanbase-dashboard-api.md) · [All operations](https://skmtc.dev/oceanbase/apis/oceanbase-dashboard-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/oceanbase/oceanbase-dashboard-api/revisions/fa579fa6f72d/schema)