/
/OceanBase Dashboard API
DocsSign in
Sign in
  • APIs
  • Generators
  • Stacks
  • Projects
  • Docs
  • History
  • Schema
Checked 2h ago · Updated 1mo ago
AccessControl11
Alarm20
Attachment1
Cluster8
Info3
Inspection7
Job2
K8sCluster10
Metric2
Monitor1
OBCluster16
OBProxy6
OBTenant23
  • getList all tenants
  • putCreate tenant
  • getList statistics information of tenants
  • getGet tenant
  • deleteDelete tenant
  • patchPatch tenant's configuration
  • getList backup jobs of specific tenant
  • getGet backup policy of specific tenant
  • putCreate backup policy of specific tenant
  • deleteDelete backup policy of specific tenant
  • patchUpdate backup policy of specific tenant
  • getList obtenant databases
  • postReplay standby log of specific standby tenant
  • putCreate obtenant pool
  • deleteDelete obtenant pool
  • patchPatch obtenant pool
  • getList related events of specific tenant
  • postChange tenant role of specific tenant
  • putCreate SQL Analyzer for specific tenant
  • deleteDelete SQL Analyzer for specific tenant
  • postChange root password of specific tenant
  • getList obtenant users
  • postUpgrade tenant compatibility version of specific tenant
Sql6
Storage1
Terminal3
User2
Webhook1
    OBTenant

    List all tenants

    List all tenants and return them

    get/api/v1/obtenants

    Query parameters

    obclusterstring

    obcluster to filter

    nsstring

    namespace to filter

    Response

    OK

    messagestring required
    successfulboolean required

    Changes