---
title: "List all tenants"
method: GET
path: "/api/v1/obtenants"
tags: ["OBTenant"]
---

# List all tenants

`GET /api/v1/obtenants`

List all tenants and return them

## Query parameters

- `obcluster` string
- `ns` string

## Response `200`

OK

- object
  - `data` ResponseOBTenantOverview[], 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
    - `primaryZone` string, required — Primary zone of the tenant
    - `scenario` string
    - `sqlAnalyzerEnabled` boolean — Whether the sql analyzer is enabled
    - `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
  - `message` string, required
  - `successful` boolean, required

## Other responses

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

## Changes

> 28 revisions in range; 1 could not be searched.

- **2024-04-17** `eaa6de82d5a4` — 1 info
  - added the new optional `query` request parameter `ns`
- **2024-03-14** `649de0f2e535` — 2 info
  - api tag `OBTenant` added
  - api tag `Obtenant` removed
- **2024-02-27** `643ae3c8d824` — 1 warning, 2 info
  - deleted the `query` request parameter `ns`
  - api tag `Obtenant` added
  - api tag `OBTenant` removed

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