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

# list obclusters

`GET /api/v1/obclusters`

list obclusters

## Response `200`

OK

- object
  - `data` ResponseOBCluster[]
    - `backupVolume` ResponseNFSVolumeSpec
      - `address` string
      - `path` string
    - `clusterId` integer
    - `clusterName` string
    - `createTime` integer
    - `image` string
    - `metrics` ResponseOBMetrics
      - `cpuPercent` integer
      - `diskPercent` integer
      - `memoryPercent` integer
    - `mode` 'NORMAL' | 'STANDALONE' | 'SERVICE'
    - `monitor` ResponseMonitorSpec
      - `image` string
      - `resource` CommonResourceSpec
        - `cpu` integer
        - `memory` integer
    - `name` string
    - `namespace` string
    - `parameters` CommonKVPair[]
      - `key` string
      - `value` string
    - `resource` CommonResourceSpec
      - `cpu` integer
      - `memory` integer
    - `rootPasswordSecret` string
    - `status` string
    - `statusDetail` string
    - `storage` ResponseOBServerStorage
      - `dataStorage` ResponseStorageSpec
        - `size` integer
        - `storageClass` string
      - `redoLogStorage` ResponseStorageSpec
        - `size` integer
        - `storageClass` string
      - `sysLogStorage` ResponseStorageSpec
        - `size` integer
        - `storageClass` string
    - `topology` ResponseOBZone[]
      - `affinities` CommonAffinitySpec[]
        - `key` string
        - `type` 'NODE' | 'POD' | 'POD_ANTI'
        - `value` string
      - `name` string
      - `namespace` string
      - `nodeSelector` CommonKVPair[]
        - `key` string
        - `value` string
      - `observers` ResponseOBServer[]
        - `address` string
        - `metrics` ResponseOBMetrics
          - `cpuPercent` integer
          - `diskPercent` integer
          - `memoryPercent` integer
        - `name` string
        - `namespace` string
        - `status` string
        - `statusDetail` string
      - `replicas` integer
      - `rootService` string
      - `status` string
      - `statusDetail` string
      - `tolerations` CommonKVPair[]
        - `key` string
        - `value` string
      - `zone` string
    - `version` string
  - `message` string
  - `successful` boolean

## 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/649de0f2e535/schema)