/

/OceanBase Dashboard API

APIs
Generators
Stacks
Projects

Docs
History
Schema
Sources

v1

latestSwagger 2.02026-07-17123181472.9 KB

AccessControl

List all accounts

List all accounts

get/api/v1/ac/accounts

Response

OK

messagestring required

successfulboolean required

All 123 operations

get List all accounts
post Create an account
delete Delete an account
patch Patch an account
get get account info
post Reset user's own password
get List all policies
get List all roles
post Create an role
delete Delete an role
patch Patch an role
post List alerts
post Diagnose alert
put Create or update alarm receiver
post List alarm receivers
get Get alarm receiver
delete Delete alarm receiver
post List alarm receiver templates
get Get alarm receiver template
put Create or update alarm route
post List alarm routes
get Get alarm route
delete Delete alarm channel
put Create or update alarm rule
post List alarm rules
get Get alarm rule
delete Delete alarm rule
put Create or update alarm silencer
post List alarm silencers
get Get alarm silencer
delete Delete alarm silencer
get Download attachment
get list k8s event
get list k8s namespaces
post create k8s namespace
get list k8s nodes
post update k8s nodes
put update k8s node labels
put update k8s node taints
get list k8s storage classes
patch Set configurable infos
get Connect to oceanbase database
get Get process info
get list inspection policies
post create or update inspection policy
get get inspection policy
delete delete inspection policy
post trigger inspection
get list inspection reports
get get inspection report
get Get job
delete Delete a job
get list remote k8s clusters
post create remote k8s cluster
put update remote k8s node labels
put update remote k8s node taints
get get remote k8s cluster
delete delete remote k8s cluster
patch put remote k8s cluster
get list remote k8s event
get list remote k8s nodes
post batch update remote k8s nodes
post User login
post User logout
get list all metrics
post query metrics
get list all endpoints
get list obclusters
post create obcluster
get get obcluster
post upgrade obcluster
delete delete obcluster
patch patch obcluster
get Download obcluster log
delete delete observers
post add obzone
delete delete obzone
post scale observer
get List OBCluster Parameters
post restart observers
put Create oceanbase cluster connection
get get obcluster statistic
get list related events
get list resource usages, the old router ending with /essential-parameters is deprecated
get list obproxies
put Create OBProxy
get Get OBProxy
delete Delete OBProxy
patch Patch OBProxy
get List OBProxy Parameters
get List all tenants
put Create tenant
get List statistics information of tenants
get Get tenant
delete Delete tenant
patch Patch tenant's configuration
get List backup jobs of specific tenant
get Get backup policy of specific tenant
put Create backup policy of specific tenant
delete Delete backup policy of specific tenant
patch Update backup policy of specific tenant
get List obtenant databases
post Replay standby log of specific standby tenant
put Create obtenant pool
delete Delete obtenant pool
patch Patch obtenant pool
get List related events of specific tenant
post Change tenant role of specific tenant
put Create SQL Analyzer for specific tenant
delete Delete SQL Analyzer for specific tenant
put Create oceanbase tenant connection
post Change root password of specific tenant
get List obtenant users
post Upgrade tenant compatibility version of specific tenant
get list sql metrics
post query plan detail info
post query SQL detail info
post query SQL history info
post list request statistics
post list top sqls
get get statistic data
get Get file
post Log alerts