---
title: "Patch obtenant pool"
method: PATCH
path: "/api/v1/obtenants/{namespace}/{name}/pools/{zoneName}"
tags: ["OBTenant"]
---

# Patch obtenant pool

`PATCH /api/v1/obtenants/{namespace}/{name}/pools/{zoneName}`

Patch an obtenant pool in a specific namespace

## Path parameters

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

## Request body

- ParamTenantPoolSpec
  - `priority` integer
  - `type` string — Enum: Full, Readonly, Columnstore
  - `unitConfig` ParamUnitConfig
    - `cpuCount` string, required
    - `iopsWeight` integer
    - `logDiskSize` string
    - `maxIops` integer
    - `memorySize` string, required
    - `minIops` integer

## Response `200`

OK

- object
  - `data` ResponseOBTenantDetail, required
    - `annotations` CommonKVPair[]
      - `key` string, required
      - `value` string, required
    - `charset` string, required — Charset of the tenant
    - `clusterResourceName` string, required — Name of the cluster belonging to
    - `createTime` string, required — Creation time of the tenant
    - `deletionProtection` boolean, required — Whether the tenant is protected from deletion
    - `locality` string, required — Locality of the tenant units
    - `name` string, required — Name of the resource
    - `namespace` string, required — Namespace of the resource
    - `primaryTenant` string
    - `primaryZone` string, required — Primary zone of the tenant
    - `restoreSource` ResponseRestoreSource
      - `archiveSource` string, required
      - `bakDataSource` string, required
      - `bakEncryptionSecret` string
      - `ossAccessSecret` string
      - `type` string, required — Enum: OSS, NFS
      - `until` string
    - `rootCredential` string
    - `scenario` string
    - `sqlAnalyzerEnabled` boolean — Whether the sql analyzer is enabled
    - `standbyROCredential` string
    - `status` string, required — Status of the tenant
    - `tenantName` string, required — Name of the tenant in the database
    - `tenantRole` string, required — Enum: Primary, Standby
    - `topology` ResponseOBTenantReplica[] — Topology of the tenant
      - `iopsWeight` integer, required
      - `logDiskSize` integer, required
      - `maxCPU` integer, required
      - `maxIops` integer, required
      - `memorySize` integer, required
      - `minCPU` integer, required
      - `minIops` integer, required
      - `priority` integer, required
      - `type` string, required — Enum: Readonly, Full
      - `zone` string, required
    - `uid` string, required — Unique identifier of the resource
    - `unitNumber` integer, required — Number of units in every zone
    - `version` string
  - `message` string, required
  - `successful` boolean, required

## Other responses

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

## Changes

- **2024-04-08** `85ec2cf1905a` — 3 breaking
  - added the new path request parameter `name`
  - added the new path request parameter `namespace`
  - added the new path request parameter `zoneName`
- **2024-03-14** `649de0f2e535` — 1 info
  - endpoint added
- **2024-02-27** `643ae3c8d824` — 1 breaking
  - api path removed without deprecation

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