查询告警事件列表 | OceanBase 文档中心

查询告警事件列表

更新时间：2026-06-15 08:56:13

功能说明

查询告警事件列表。

调用说明

接口约束

调用者需要告警功能的读权限。

请求路径

GET /api/v2/alarm/alarms

请求参数

名称	类型	是否必选	示例值	描述
page	Integer	否	1	请求数据的分页页码。值从 1 开始。默认值：1
size	Integer	否	10	请求数据的分页大小。默认值：10 最大值：200
appType	String	否	OceanBase	应用类别（告警来源），取值范围： OceanBase OCP OMS OBProxy Log Backup
scope	String	否	Cluster	告警范围，取值范围： Cluster Tenant Host Service Arbitration Backup OceanBaseLog OBProxyLog * HostLog
level	Integer	否	1	告警等级 [1~5] ，分别对应：Down、Critical、Alert、Caution、Info
status	String	否	Active	告警状态，取值范围： Active Inactive Silenced Inhibited
activeAtStart	Datetime	否	2020-11-11T11:12:13.127+08:00	告警触发起始时间
activeAtEnd	Datetime	否	2020-11-11T17:11:13.127+08:00	告警触发截止时间
isSubscribedByMe	Boolean	否	true	是否被我订阅
keyword	String	否	hello	关键字匹配

返回结果

基础数据结构

参数	类型	说明
data	Object	请求的数据。
├─ contents	Array	告警事件的列表，告警事件的数据结构见下表。
├─ page	Object	分页信息。
├─ totalElements	Integer	总记录数。
├─ totalPage	Integer	总页数。
├─ number	Integer	当前页码。
├─ size	Integer	当前页大小。
successful	Boolean	请求是否成功。
timestamp	Datetime	服务端完成请求的时间戳。
duration	Integer	服务端处理请求的时间（毫秒）。
status	Integer	符合 HTTP Status 规范的编码。
traceId	String	请求的 Trace Id，用于排查问题。
server	String	响应请求的服务端的地址。

告警事件的数据结构

参数	类型	说明
id	Integer	告警事件的 Id。
appType	String	应用类型，取值范围： OceanBase OCP OMS OBProxy Log
alarmType	String	告警类型
scope	String	告警范围，取值范围： Cluster Tenant Host Service Arbitration Backup OceanBaseLog OBProxyLog * HostLog
level	Integer	告警等级 [1~5] ，分别对应：Down、Critical、Alert、Caution、Info
status	String	告警状态，取值范围： Active Inactive Silenced Inhibited
target	String	告警事件的目标对象，基于告警规则的目标模板生成。
summary	String	告警事件的概述，基于告警规则的概述模板生成。
description	String	告警事件的详情，基于告警规则的详情模板生成
activeAt	Datetime	告警事件的生成时间
resolvedAt	Datetime	告警事件的消除时间
updatedAt	Datetime	告警事件的更新时间
labels	Object	告警事件的标签和值。

示例

请求示例

GET /api/v2/alarm/alarms

返回示例

{
  "data": {
    "contents": [
      {
        "activeAt": "2023-04-25T10:04:17Z",
        "alarmTarget": {
          "appType": "OceanBase",
          "excludeTargets": [],
          "includeTargets": [
            {
              "cluster": {
                "clusterId": 1,
                "name": "TEST_CLUSTER",
                "obClusterId": 12
              },
              "tenants": [
                {
                  "name": "oracle",
                  "obTenantId": 1002,
                  "tenantId": 3
                }
              ]
            }
          ],
          "scope": "Tenant"
        },
        "alarmTemplateId": 0,
        "alarmType": "ob_tenant_exists_expired_xa_trans",
        "appType": "OceanBase",
        "description": "集群：TEST_CLUSTER，租户：oracle 存在XA悬挂事务。会话ID：0，事务ID：10609937150880685421，事务创建时间：2023-04-25T14:05:47.766+08:00，事务最长持续时长：5 小时 27 分 53.51 秒。",
        "gmtCreate": "2023-04-25T10:04:17Z",
        "gmtModified": "2023-04-25T11:34:17.39943Z",
        "id": 3000024,
        "labels": {
          "alarm_active_at": "2023-04-25T10:04:17Z",
          "alarm_description": "集群：TEST_CLUSTER，租户：oracle 存在XA悬挂事务。会话ID：0，事务ID：10609937150880685421，事务创建时间：2023-04-25T14:05:47.766+08:00，事务最长持续时长：5 小时 27 分 53.51 秒。",
          "alarm_description_en_us": "OceanBase cluster: TEST_CLUSTER, tenant: oracle, expired XA transactions exist. Session id: 0, Trans id: 10609937150880685421, trans create time: 2023-04-25T14:05:47.766+08:00, the max trans duration: 5 hours 27 mins 53.51 secs.",
          "alarm_description_zh_cn": "集群：TEST_CLUSTER，租户：oracle 存在XA悬挂事务。会话ID：0，事务ID：10609937150880685421，事务创建时间：2023-04-25T14:05:47.766+08:00，事务最长持续时长：5 小时 27 分 53.51 秒。",
          "alarm_description_zh_tw": "集群：TEST_CLUSTER，租戶：oracle 存在XA懸掛事務。會話ID：0，事務ID：10609937150880685421，事務創建時間：2023-04-25T14:05:47.766+08:00，事務最長持續時長：5 小時 27 分 53.51 秒。",
          "alarm_evaluation_interval": "20",
          "alarm_is_build_in_rule": "true",
          "alarm_level": "2",
          "alarm_name": "OceanBase租户存在XA悬挂事务",
          "alarm_name_en_us": "OceanBase tenant contains XA expired transaction",
          "alarm_name_zh_cn": "OceanBase租户存在XA悬挂事务",
          "alarm_name_zh_tw": "OceanBase租戶存在XA懸掛事務",
          "alarm_scope": "Tenant",
          "alarm_status": "Active",
          "alarm_summary": "alarm_template_id=0:ob_cluster=TEST_CLUSTER-12:tenant_name=oracle:trans_hash=10609937150880685421 OceanBase租户存在XA悬挂事务",
          "alarm_summary_en_us": "alarm_template_id=0:ob_cluster=TEST_CLUSTER-12:tenant_name=oracle:trans_hash=10609937150880685421 OceanBase tenant contains XA expired transaction",
          "alarm_summary_zh_cn": "alarm_template_id=0:ob_cluster=TEST_CLUSTER-12:tenant_name=oracle:trans_hash=10609937150880685421 OceanBase租户存在XA悬挂事务",
          "alarm_summary_zh_tw": "alarm_template_id=0:ob_cluster=TEST_CLUSTER-12:tenant_name=oracle:trans_hash=10609937150880685421 OceanBase租戶存在XA懸掛事務",
          "alarm_target": "alarm_template_id=0:ob_cluster=TEST_CLUSTER-12:tenant_name=oracle:trans_hash=10609937150880685421",
          "alarm_template_id": "0",
          "alarm_threshold": "1200",
          "alarm_type": "ob_tenant_exists_expired_xa_trans",
          "alarm_updated_at": "2023-04-25T11:34:17Z",
          "app": "OceanBase",
          "app_type": "OceanBase",
          "cluster_id": "1",
          "is_xa_trans": "1",
          "message_type": "Alarm",
          "metrics": "xa_trans_max_duration_seconds",
          "ob_cluster": "TEST_CLUSTER",
          "ob_cluster_id": "12",
          "ob_cluster_name": "TEST_CLUSTER",
          "ob_tenant": "oracle",
          "ob_tenant_id": "1002",
          "obregion": "TEST_CLUSTER",
          "ocp_ip": "127.1",
          "session_id": "0",
          "sql_alarm_type": "trans_stat",
          "tenant_id": "3",
          "tenant_name": "oracle",
          "trans_create_time": "2023-04-25T14:05:47.766+08:00",
          "trans_hash": "10609937150880685421",
          "trans_id": "{hash:10609937150880685421, inc:404115548, addr:\"xxx.xxx.xxx.xxx:2882\", t:1677651496056481}",
          "trans_max_duration_seconds": "19673.51",
          "trans_state": "pending",
          "trans_state_name": "PENDING_TRANSACTION",
          "trans_type": "xa",
          "trans_type_name": "XA_TRANSACTION",
          "value": "19673.51",
          "value_en_us": "5 hours 27 mins 53.51 secs",
          "value_shown": "5 小时 27 分 53.51 秒",
          "value_zh_cn": "5 小时 27 分 53.51 秒",
          "value_zh_tw": "5 小時 27 分 53.51 秒",
          "values": "19673.51",
          "xa_trans_max_duration_seconds": "19673.51",
          "xa_trans_max_duration_seconds_alarm_threshold": "1200",
          "xa_trans_max_duration_seconds_value": "19673.51",
          "xa_trans_max_duration_seconds_value_en_us": "5 hours 27 mins 53.51 secs",
          "xa_trans_max_duration_seconds_value_zh_cn": "5 小时 27 分 53.51 秒",
          "xa_trans_max_duration_seconds_value_zh_tw": "5 小時 27 分 53.51 秒"
        },
        "level": 2,
        "messagePush": {
          "configured": true,
          "noSuccessCount": 0,
          "successCount": 10
        },
        "name": "OceanBase租户存在XA悬挂事务",
        "scope": "Tenant",
        "status": "Active",
        "statusUpdatedAt": "2023-04-25T10:04:17Z",
        "summary": "alarm_template_id=0:ob_cluster=TEST_CLUSTER-12:tenant_name=oracle:trans_hash=10609937150880685421 OceanBase租户存在XA悬挂事务",
        "target": "alarm_template_id=0:ob_cluster=TEST_CLUSTER-12:tenant_name=oracle:trans_hash=10609937150880685421",
        "updatedAt": "2023-04-25T11:34:17Z"
      }
    ],
    "page": {
      "number": 1,
      "size": 10,
      "totalElements": 1,
      "totalPages": 1
    }
  },
  "duration": 29,
  "server": "xxxx",
  "status": 200,
  "successful": true,
  "timestamp": "2023-04-25T19:36:56.705+08:00",
  "traceId": "eba3a5bbd9b24f38"
}