---
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
  - `clusterName` string
  - `mode` 'NORMAL' | 'STANDALONE' | 'SERVICE'
  - `monitor` ParamMonitorSpec
    - `image` string
    - `resource` CommonResourceSpec
      - `cpu` integer
      - `memory` integer
  - `name` string
  - `namespace` string
  - `observer` ParamOBServerSpec
    - `image` string
    - `resource` CommonResourceSpec
      - `cpu` integer
      - `memory` integer
    - `storage` ParamOBServerStorageSpec
      - `data` CommonStorageSpec
        - `size` integer
        - `storageClass` string
      - `log` CommonStorageSpec
        - `size` integer
        - `storageClass` string
      - `redoLog` CommonStorageSpec
        - `size` integer
        - `storageClass` string
  - `parameters` CommonKVPair[]
    - `key` string
    - `value` string
  - `rootPassword` string
  - `topology` ParamZoneTopology[]
    - `affinities` CommonAffinitySpec[]
      - `key` string
      - `type` 'NODE' | 'POD' | 'POD_ANTI'
      - `value` string
    - `nodeSelector` CommonKVPair[]
      - `key` string
      - `value` string
    - `replicas` integer
    - `tolerations` CommonKVPair[]
      - `key` string
      - `value` string
    - `zone` string

## Response `200`

OK

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

## Other responses

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

## Changes

- **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/post.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/2fe42416b4d4/schema)