---
title: "create obcluster"
method: POST
path: "/api/v1/obclusters"
tags: ["OBCluster"]
---

# create obcluster

`POST /api/v1/obclusters`

create obcluster

## Request body

- ParamCreateOBClusterParam
  - `backupVolume` ParamNFSVolumeSpec
    - `address` string
    - `path` string
  - `clusterId` integer, required
  - `clusterName` string, required
  - `deletionProtection` boolean
  - `mode` 'NORMAL' | 'STANDALONE' | 'SERVICE', required
  - `monitor` ParamMonitorSpec
    - `image` string, required
    - `resource` CommonResourceSpec, required
      - `cpu` integer, required
      - `memory` integer, required
  - `name` string, required
  - `namespace` string, required
  - `observer` ParamOBServerSpec, required
    - `image` string, required
    - `resource` CommonResourceSpec, required
      - `cpu` integer, required
      - `memory` integer, required
    - `storage` ParamOBServerStorageSpec, required
      - `data` CommonStorageSpec, required
        - `size` integer, required
        - `storageClass` string
      - `log` CommonStorageSpec, required
        - `size` integer, required
        - `storageClass` string
      - `redoLog` CommonStorageSpec, required
        - `size` integer, required
        - `storageClass` string
  - `parameters` CommonKVPair[]
    - `key` string, required
    - `value` string, required
  - `proxyroPassword` string
  - `pvcIndependent` boolean
  - `rootPassword` string, required
  - `scenario` string, required — Enum: express_oltp, express_oltp, olap, kv, htap, express_oltp_perf
  - `topology` ParamZoneTopology[], 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
    - `nodeSelector` CommonKVPair[]
      - `key` string, required
      - `value` string, required
    - `replicas` integer, 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

## Response `200`

OK

- ResponseAPIResponse
  - `data` unknown, required
  - `message` string, required
  - `successful` boolean, required

## Other responses

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

---

[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)