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

## Response `200`

OK

- object
  - `data` ResponseOBTenantBrief[]
    - `charset` string — Charset of the tenant
    - `clusterName` string — Name of the cluster belonging to
    - `createTime` string — Creation time of the tenant
    - `locality` string — Locality of the tenant units
    - `name` string — Name of the resource
    - `namespace` string — Namespace of the resource
    - `status` string — Status of the tenant
    - `tenantName` string — Name of the tenant in the database
    - `tenantRole` string — Enum: Primary, Standby
    - `topology` ResponseOBTenantReplica[] — Topology of the tenant
      - `iopsWeight` integer
      - `logDiskSize` string
      - `maxCPU` string
      - `maxIops` integer
      - `memorySize` string
      - `minCPU` string
      - `minIops` integer
      - `priority` integer
      - `type` string — Enum: Readonly, Full
      - `zone` string
    - `unitNumber` integer — Number of units in every zone
  - `message` string
  - `successful` boolean

## Other responses

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

## Changes

- **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/643ae3c8d824/schema)