---
title: "patch obcluster"
method: PATCH
path: "/api/v1/obclusters/namespace/{namespace}/name/{name}"
tags: ["OBCluster"]
---

# patch obcluster

`PATCH /api/v1/obclusters/namespace/{namespace}/name/{name}`

patch obcluster configuration including resources, storage, monitor and parameters

## Path parameters

- `namespace` string, required
- `name` string, required

## Request body

- ParamPatchOBClusterParam
  - `addDeletionProtection` boolean
  - `backupVolume` ParamNFSVolumeSpec
    - `address` string
    - `path` string
  - `deletedParameters` string[] — Delete some parameters
  - `modifiedParameters` CommonKVPair[] — Add or modify some parameters
    - `key` string, required
    - `value` string, required
  - `monitor` ParamMonitorSpec
    - `image` string, required
    - `resource` CommonResourceSpec, required
      - `cpu` integer, required
      - `memory` integer, required
  - `parameters` CommonKVPair[] — Replace all parameters
    - `key` string, required
    - `value` string, required
  - `removeBackupVolume` boolean
  - `removeDeletionProtection` boolean
  - `removeMonitor` boolean
  - `resource` CommonResourceSpec
    - `cpu` integer, required
    - `memory` integer, required
  - `storage` ParamOBServerStorageSpec
    - `data` CommonStorageSpec, required
      - `size` integer, required
      - `storageClass` string
    - `log` CommonStorageSpec, required
      - `size` integer, required
      - `storageClass` string
    - `redoLog` CommonStorageSpec, required
      - `size` integer, required
      - `storageClass` string

## Response `200`

OK

- object
  - `data` ResponseOBCluster, required
    - `annotations` CommonKVPair[]
      - `key` string, required
      - `value` string, required
    - `backupVolume` ResponseNFSVolumeSpec
      - `address` string, required
      - `path` string, required
    - `clusterId` integer, required
    - `clusterName` string, required
    - `createTime` integer, required
    - `deletionProtection` boolean, 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` ResponseParameterSpec[], required
      - `name` string, required
      - `specValue` string, required
      - `value` string, required
    - `pvcIndependent` boolean, required
    - `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
    - `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
    - `version` string
  - `message` string, required
  - `successful` boolean, required

## Other responses

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

## Changes

- **2026-07-17** `fa579fa6f72d` — 1 info
  - endpoint added
- **2024-02-27** `643ae3c8d824` — 1 breaking
  - api removed without deprecation

[Change history](https://skmtc.dev/oceanbase/apis/oceanbase-dashboard-api/changes/api/v1/obclusters/namespace/:namespace/name/:name/patch.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)