--- title: github-fill description: "查询告警事件 功能说明 查询指定告警事件的详细信息。 调用说明 接口约束 调用者需要告警功能的读权限。 请求路径 GET /api/v2/alarm/alarms/{id} 请求参数 path： 名称 类型 示例值 描述 id Integer 1023 告警事件的 ID。 返回结果 基础数据结构 参数 类型 说明 d…" --- 切换语言 - 中文站 - 简体中文 - International - English - 日本站 - 日本語 文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*lJTmRZ61jSUAAAAAAAAAAAAADiGDAQ/original) 云平台 OCPV 4.3.0 # 查询告警事件 更新时间：2026-04-14 11:55:54 [编辑](https://github.com/oceanbase/ocp-doc/edit/V4.3.0/zh-CN/1900.reference-guide/200.api-reference/1000.alert/400.query-alert-events.md) ## **功能说明** 查询指定告警事件的详细信息。 ## **调用说明** ### 接口约束 调用者需要告警功能的读权限。 ### 请求路径 `GET /api/v2/alarm/alarms/{id}` ### 请求参数 **path：** | 名称 | 类型 | 示例值 | 描述 | | --- | --- | --- | --- | | id | Integer | 1023 | 告警事件的 ID。 | ### 返回结果 **基础数据结构** | 参数 | 类型 | 说明 | | --- | --- | --- | | data | Object | 告警事件的列表，详情参见 **告警事件数据结构**。 | | 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 | 告警事件的标签和值。 | ## **示例** ### 请求示例 查看告警事件 ID 为 1000159 的详细信息。 ```json GET /api/v2/alarm/alarms/100159 ``` ### 返回示例 ```json { "data": { "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 小时 33 分 58.51 秒。", "gmtCreate": "2023-04-25T10:04:17Z", "gmtModified": "2023-04-25T11:40:17.397559Z", "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 小时 33 分 58.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 33 mins 58.51 secs.", "alarm_description_zh_cn": "集群：TEST_CLUSTER，租户：oracle 存在XA悬挂事务。会话ID：0，事务ID：10609937150880685421，事务创建时间：2023-04-25T14:05:47.766+08:00，事务最长持续时长：5 小时 33 分 58.51 秒。", "alarm_description_zh_tw": "集群：TEST_CLUSTER，租戶：oracle 存在XA懸掛事務。會話ID：0，事務ID：10609937150880685421，事務創建時間：2023-04-25T14:05:47.766+08:00，事務最長持續時長：5 小時 33 分 58.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:40: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": "20038.51", "trans_state": "pending", "trans_state_name": "PENDING_TRANSACTION", "trans_type": "xa", "trans_type_name": "XA_TRANSACTION", "value": "20038.51", "value_en_us": "5 hours 33 mins 58.51 secs", "value_shown": "5 小时 33 分 58.51 秒", "value_zh_cn": "5 小时 33 分 58.51 秒", "value_zh_tw": "5 小時 33 分 58.51 秒", "values": "20038.51", "xa_trans_max_duration_seconds": "20038.51", "xa_trans_max_duration_seconds_alarm_threshold": "1200", "xa_trans_max_duration_seconds_value": "20038.51", "xa_trans_max_duration_seconds_value_en_us": "5 hours 33 mins 58.51 secs", "xa_trans_max_duration_seconds_value_zh_cn": "5 小时 33 分 58.51 秒", "xa_trans_max_duration_seconds_value_zh_tw": "5 小時 33 分 58.51 秒" }, "level": 2, "name": "OceanBase租户存在XA悬挂事务", "obCluster": { "appType": "OceanBase", "excludeTargets": [], "includeTargets": [ { "cluster": { "clusterId": 1, "name": "TEST_CLUSTER", "obClusterId": 12 } } ], "scope": "Cluster" }, "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", "targetLabels": { "alarm_template_id": "0", "ob_cluster": "TEST_CLUSTER", "ob_cluster_id": "12", "tenant_name": "oracle", "trans_hash": "10609937150880685421" }, "updatedAt": "2023-04-25T11:40:17Z" }, "duration": 10, "server": "127.1", "status": 200, "successful": true, "timestamp": "2023-04-25T19:40:27.475+08:00", "traceId": "6f6a24af73b14704" } ``` 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线