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

- object
  - `data` ResponseOBCluster, required
    - `backupVolume` ResponseNFSVolumeSpec
      - `address` string, required
      - `path` string, required
    - `clusterId` integer, required
    - `clusterName` string, required
    - `createTime` integer, required
    - `image` string, required
    - `metrics` ResponseOBMetrics
      - `cpuPercent` integer, required
      - `diskPercent` integer, required
      - `memoryPercent` integer, required
    - `mode` 'NORMAL' | 'STANDALONE' | 'SERVICE', required
    - `monitor` ResponseMonitorSpec
      - `image` string, required
      - `resource` ResponseResourceSpecRender, required
        - `cpu` integer, required
        - `memory` integer, required
    - `name` string, required
    - `namespace` string, required
    - `parameters` CommonKVPair[], required
      - `key` string
      - `value` string
    - `resource` ResponseResourceSpecRender, required
      - `cpu` integer, required
      - `memory` integer, required
    - `rootPasswordSecret` string, required
    - `status` string, required
    - `statusDetail` string, required
    - `storage` ResponseOBServerStorage, required
      - `dataStorage` ResponseStorageSpec, required
        - `size` integer, required
        - `storageClass` string, required
      - `redoLogStorage` ResponseStorageSpec, required
        - `size` integer, required
        - `storageClass` string, required
      - `sysLogStorage` ResponseStorageSpec, required
        - `size` integer, required
        - `storageClass` string, required
    - `topology` ResponseOBZone[], required
      - `affinities` CommonAffinitySpec[]
        - `key` string
        - `type` 'NODE' | 'POD' | 'POD_ANTI'
        - `value` string
      - `name` string, required
      - `namespace` string, required
      - `nodeSelector` CommonKVPair[]
        - `key` string
        - `value` string
      - `observers` ResponseOBServer[]
        - `address` string, required
        - `metrics` ResponseOBMetrics
          - `cpuPercent` integer, required
          - `diskPercent` integer, required
          - `memoryPercent` integer, required
        - `name` string, required
        - `namespace` string, required
        - `status` string, required
        - `statusDetail` string, required
      - `replicas` integer, required
      - `rootService` string
      - `status` string, required
      - `statusDetail` string, required
      - `tolerations` CommonKVPair[]
        - `key` string
        - `value` string
      - `zone` string, required
    - `uid` string, required
    - `version` string
  - `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/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/3e1a27cd744f/schema)