Obtain alert history|V4.4.2|OceanBase Cloud Platform|OCP docs|Distributed Database

Obtain alert history

Last Updated：2026-06-12 02:01:01 Updated

Overview

This API is used to query the alert history.

API details

Constraints

The caller must pass the authentication for OCP application services.

Request path

GET /api/v2/alarm/alarms/history

Request parameters

body:

Parameter	Type	Required	Example value	Description
appType	String	No	OceanBase	Application category (alert source). Valid values: OceanBase OCP OMS OBProxy Binlog Log OBLB OBDNS ODP
scope	String	No	Cluster	Alert scope. Valid values: Cluster Tenant Host Service BinlogService Arbitration Backup OceanBaseLog OBProxyLog HostLog
target	Array	No	alarm_template_id=0:ob_cluster=TEST_CLUSTER-12:tenant_name=oracle:trans_hash=10609937150880685421	The target object of the alert, generated based on the target template in the alert rule.
alarmType	String	No	ob_tenant_exists_expired_xa_trans	Alert type.
level	Array	No	1	Alert levels [1~5], corresponding to: Down, Critical, Alert, Caution, and Info.
alarmGroupIds	integer	No	[1,2,3]	List of alert group IDs, separated by commas.
status	Array	No	Active	Alert status. Valid values: Active Inactive Silenced Inhibited
activeAtStart	String	No	2020-11-11T11:12:13.127+08:00	The time when the alert was triggered.
activeAtEnd	String	No	2020-11-11T17:11:13.127+08:00	The deadline for triggering the alert.
keyword	String	No	hello	Keyword match.

Response parameters

Basic data structures

Parameter	Type	Description
data	Object	The requested data.
├─ contents	Array	Alert details. For more information, see OcpAlarm data structure.
├─ page	Object	Pagination information. For details, see page data structure.
successful	Boolean	Whether the request was successful.
timestamp	Datetime	The timestamp when the server completed the request.
duration	Integer	The time taken by the server to process the request, in milliseconds.
status	Integer	An HTTP status code.
traceId	String	The trace ID of the request, used for troubleshooting.
server	String	The address of the application service that responded to the request.

OcpAlarm data structure

Parameter	Type	Description
gmtCreate	String	Creation time.
gmtModified	String	Modified at.
id	Integer	Alert event ID.
alarmId	Integer	Alert ID.
alarmTemplateId	Integer	Alert template ID.
appType	String	Application type. Valid values: OceanBase OCP OMS OBProxy Binlog Log OBLB OBDNS ODP
alarmType	String	Alert type.
scope	String	Alert scope. Valid values: Cluster Tenant Host Service BinlogService Arbitration Backup OceanBaseLog OBProxyLog HostLog
level	Integer	The alert severity levels [1~5] correspond to Down, Critical, Alert, Caution, and Info, respectively.
status	String	Alert status. Valid values: Active Inactive Silenced Inhibited
target	String	The target object of the alert, generated based on the target template in the alert rule.
alarmTarget	Object	Information about the alert target. For more information, see AlertTarget data structure.
obCluster	Object	For more information, see AlarmTarget data structure.
name	String	Alert name.
summary	String	Alert overview, generated based on the overview template of the alert rule.
description	String	Alert details, generated based on the details template of the alert rule.
activeAt	String	The time when the alert was generated.
resolvedAt	String	Alert clearance time.
updatedAt	String	The time when the alert was updated.
statusUpdatedAt	String	The time when the alert status was updated.
labels	Object	The tag and value of the alert event.
targetLabels	Object	The tag and value of the alert object, for example,`svr_ip`、`ob_tenant_id`and so on.
metricGroup	Object	Array of metric groups. For more information, see MetricGroup data structure.
messagePush	Object	Alert push details. For more information, see MessagePush data structure.
alarmGroups	Array	The list of alert groups.
originalAlarmId	Integer	The plaintiff's ID.
containSnapshot	Boolean	Whether to include abnormal snapshots.
containSelfcure	Boolean	Whether to include self-healing.
resolveComment	String	Additional information about how to resolve the alert.

AlarmTarget data structure

Parameter	Type	Description
appType	String	Application type. Valid values: OceanBase OCP OMS OBProxy Binlog Log OBLB OBDNS ODP
scope	String	Alert scope. Valid values: Cluster Tenant Host Service BinlogService Arbitration Backup OceanBaseLog OBProxyLog HostLog
includeTargets	Array	Alert target (positive selection).
excludeTargets	Array	Exclude Alert Targets (Inverse Selection).

MetricGroup data structure

Parameter	Type	Description
id	Integer	The ID of the metric group.
key	String	The encoded name of the metric group.
className	String	The class name corresponding to the metric group.
name	String	The name of the metric group, which supports internationalization.
description	String	The description of the metric group, which supports internationalization.
metrics	Array	An array of metric metadata.
dimension	String	The dimension for grouping metrics.
withLabel	Boolean	Whether it is a labeled monitoring data group. Default value:`false`.
order	Integer	Sort parameter.

MessagePush data structure

Parameter	Type	Description
configured	Boolean	Whether to enable alert push.
successCount	Integer	Number of successfully pushed messages.
noSuccessCount	Integer	The number of failed message pushes.

Page data structure

Parameter	Type	Description
totalElements	Integer	Total Records.
totalPage	Integer	Total number of pages.
number	Integer	Current page number.
size	Integer	Number of records on the current page.

Examples

Request example