/
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
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
Attachment
1
Cluster
8
Info
3
Inspection
7
Job
2
K8sCluster
10
Metric
2
Monitor
1
OBCluster
16
OBProxy
6
OBTenant
23
Sql
6
Storage
1
Terminal
3
User
2
Webhook
1
Alarm
Create or update alarm rule
Create or update alarm rule.
put
/api/v1/alarm/rule/rules
Request body
RuleRule
required
description
string
required
duration
integer
required
instanceType
'unknown'
|
'obcluster'
|
'obzone'
|
'obtenant'
|
'observer'
required
labels
CommonKVPair[]
required
name
string
required
query
string
required
severity
'critical'
|
'warning'
|
'caution'
|
'info'
required
summary
string
required
type
'builtin'
|
'customized'
Response
OK
object
required
data
RuleRuleResponse
required
message
string
required
successful
boolean
required
Changes