/
OC
oceanbase
/
OceanBase Dashboard API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 2h ago · Updated 1mo ago
Details
Filter operations
AccessControl
11
Alarm
20
Attachment
1
Cluster
8
Info
3
Inspection
7
Job
2
K8sCluster
10
Metric
2
Monitor
1
OBCluster
16
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
get
get obcluster statistic
get
list related events
get
list resource usages, the old router ending with /essential-parameters is deprecated
OBProxy
6
OBTenant
23
Sql
6
Storage
1
Terminal
3
User
2
Webhook
1
OBCluster
create obcluster
create obcluster
post
/api/v1/obclusters
Request body
ParamCreateOBClusterParam
required
backupVolume
ParamNFSVolumeSpec
clusterId
integer
required
clusterName
string
required
deletionProtection
boolean
mode
'NORMAL'
|
'STANDALONE'
|
'SERVICE'
required
monitor
ParamMonitorSpec
name
string
required
namespace
string
required
observer
ParamOBServerSpec
required
parameters
CommonKVPair[]
proxyroPassword
string
pvcIndependent
boolean
rootPassword
string
required
scenario
string
required
Enum: express_oltp, express_oltp, olap, kv, htap, express_oltp_perf
topology
ParamZoneTopology[]
required
Response
OK
ResponseAPIResponse
required
{"stackTrail":"components:schemas:response.APIResponse:properties:data","oasType":"schema","type":"unknown"}
message
string
required
successful
boolean
required
Changes