获取报警历史详情DescribeAlarmRecord

日志服务 BLS

  • 功能发布记录
  • 产品描述
    • 产品介绍
    • 使用限制
  • 产品定价
  • 快速入门
    • 简介
    • 安装收集器
    • 创建日志集
    • 创建传输任务
    • 日志分析和报警
    • 创建投递任务
    • 创建日志集
    • 简介
    • 日志分析和报警
    • 创建投递任务
    • 创建传输任务
    • 安装收集器
  • 操作指南
    • 百度智能云环境准备
    • 概览
    • 收集器
      • 主机安装收集器
      • 在k8s环境安装收集器
      • 设置收集器启动参数
      • 收集器管理
      • 收集器发行版本
    • 查询分析
      • 日志查询
      • 检索语法
      • SQL语法
    • 日志采集
      • 传输任务采集
        • 管理传输任务
        • 创建传输任务
      • 使用Kafka协议上传日志
    • 日志管理
      • 日志集管理
      • 日志视图
    • 仪表盘
      • 概述
      • 管理仪表盘
      • 管理仪表盘图表
    • 报警管理
      • 报警概述
      • 报警策略
        • 管理报警策略
        • 触发条件
      • 报警通知
        • 报警通知模版
        • 报警回调
      • 报警执行统计
      • 报警历史
    • 数据处理
      • 定时SQL分析
        • 创建定时SQL分析任务
        • 管理定时SQL分析任务
      • 日志投递
        • 日志投递概述
        • 创建投递任务
        • 管理投递任务
      • 数据加工
        • 数据加工函数总览
        • 事件操作函数
        • 字段值提取函数
        • 字段操作函数
        • 映射富化函数
        • 流程控制函数
      • 实时消费
    • 日志应用
      • 智能诊断
    • 多用户访问控制
  • 开发指南
    • API参考
      • API概述
      • 通用说明
      • 名词解释
      • 接口概览
      • 通用错误码
      • 服务域名
      • API功能发布记录
      • 日志组Project相关接口
        • 创建日志组CreateProject
        • 更新日志组UpdateProject
        • 删除日志组DeleteProject
        • 获取日志组列表ListProject
        • 获取日志组详情DescribeProject
      • 日志集LogStore相关接口
        • 创建日志集CreateLogStore
        • 修改日志集UpdateLogStore
        • 删除日志集DeleteLogStore
        • 获取日志集列表ListLogStore
        • 获取日志集详情DescribeLogStore
        • 批量获取日志集BatchGetLogStore
      • 日志流LogStream相关接口
        • 获取日志流列表ListLogStream
      • 日志记录LogRecord相关接口
        • 检索分析日志QueryLogRecord
        • 直方图接口QueryLogHistogram
        • 推送日志PushLogRecord
        • 获取日志记录PullLogRecord
      • 日志视图相关接口
        • 创建日志视图CreateLogStoreView
        • 修改日志视图UpdateLogStoreView
        • 删除日志视图DeleteLogStoreView
        • 获取日志视图列表ListLogStoreView
        • 获取日志视图详情DescribeLogStoreView
      • 下载日志Download相关接口
        • 创建下载任务CreateDownloadTask
        • 删除下载任务DeleteDownloadTask
        • 获取下载任务列表ListDownloadTask
        • 获取下载任务地址GetDownloadTaskLink
        • 获取下载任务详情DescribeDownloadTask
      • 快速查询FastQuery相关接口
        • 创建快速查询CreateFastQuery
        • 更新快速查询UpdateFastQuery
        • 删除快速查询DeleteFastQuery
        • 获取快速查询列表ListFastQuery
        • 获取快速查询详情DescribeFastQuery
      • 传输任务Task相关接口
        • 创建传输任务CreateTask
        • 更新传输任务UpdateTask
      • 报警Alarm相关接口
        • 创建报警策略CreateAlarmPolicy
        • 启用报警策略EnableAlarmPolicy
        • 获取报警历史详情DescribeAlarmRecord
        • 更新报警策略UpdateAlarmPolicy
        • 删除报警策略DeleteAlarmPolicy
        • 获取报警执行列表ListAlarmExecutions
        • 获取报警策略列表ListAlarmPolicy
        • 获取报警策略详情DescribeAlarmPolicy
        • 获取报警执行统计ListAlarmExecutionStats
        • 检验报警策略执行条件ValidateAlarmCondition
        • 禁用报警策略DisableAlarmPolicy
        • 获取报警历史列表ListAlarmRecord
        • 检验报警策略查询语句ValidateAlarmPolicySQL
      • 日志投递LogShipper相关接口
        • 创建日志投递CreateLogShipper
        • 更新日志投递UpdateLogShipper
        • 删除日志投递任务DeleteSingleLogShipper
        • 批量设置日志投递任务状态BulkSetLogShipperStatus
        • 设置日志投递任务状态SetSingleLogShipperStatus
        • 获取日志投递记录ListLogShipperRecord
        • 批量删除日志投递任务BulkDeleteLogShipper
        • 获取日志投递列表ListLogShipper
        • 获取日志投递详情GetLogShipper
      • 日志集模板相关接口
        • 创建日志集模板CreateLogStoreTemplate
        • 更新日志集模板UpdateLogStoreTemplate
        • 删除日志集模板DeleteLogStoreTemplates
        • 获取日志集模板列表DescribeLogStoreTemplates
        • 获取日志集模板详情DescribeLogStoreTemplate
      • 索引Index相关接口
        • 创建索引CreateIndex
        • 更新索引UpdateIndex
        • 删除索引DeleteIndex
        • 获取索引详情DescribeIndex
      • 兼容Elasticsearch相关接口
        • 检索和分析BLS日志 AsyncSearch
        • 查询索引列表 ResolveIndex
        • 推荐字段取值 TermsEnum
        • 获取索引字段列表 FieldCaps
    • SDK参考
      • SDK隐私政策
      • SDK开发者个人信息保护合规指引
      • Android & ISO SDK下载
      • Go SDK
        • 概述
        • 初始化
        • 安装SDK工具包
        • Project操作
        • 日志集LogStore操作
        • 日志流LogStream操作
        • 日志记录LogRecord操作
        • 日志投递LogShipper操作
        • 快速查询FastQuery操作
        • 下载任务操作
        • 索引Index操作
        • 版本发布记录
      • iOS SDK
        • 概述
        • 快速开始
        • 版本发布记录
      • Java SDK
        • 概述
        • 日志记录LogRecord操作
        • 安装SDK工具包
      • Android SDK
        • 概述
        • 快速开始
        • 版本发布记录
    • 导入SLS采集配置
  • 最佳实践
    • 使用同环比作为报警触发条件
    • 通过Grafana使用BLS
    • 使用Grafana访问日志服务的Elasticsearch兼容接口
    • BLS接入Kibana
  • 常见问题
    • 常见问题总览
    • 配置类问题
    • 故障类问题
  • 日志服务等级协议SLA
所有文档
menu
没有找到结果,请重新输入

日志服务 BLS

  • 功能发布记录
  • 产品描述
    • 产品介绍
    • 使用限制
  • 产品定价
  • 快速入门
    • 简介
    • 安装收集器
    • 创建日志集
    • 创建传输任务
    • 日志分析和报警
    • 创建投递任务
    • 创建日志集
    • 简介
    • 日志分析和报警
    • 创建投递任务
    • 创建传输任务
    • 安装收集器
  • 操作指南
    • 百度智能云环境准备
    • 概览
    • 收集器
      • 主机安装收集器
      • 在k8s环境安装收集器
      • 设置收集器启动参数
      • 收集器管理
      • 收集器发行版本
    • 查询分析
      • 日志查询
      • 检索语法
      • SQL语法
    • 日志采集
      • 传输任务采集
        • 管理传输任务
        • 创建传输任务
      • 使用Kafka协议上传日志
    • 日志管理
      • 日志集管理
      • 日志视图
    • 仪表盘
      • 概述
      • 管理仪表盘
      • 管理仪表盘图表
    • 报警管理
      • 报警概述
      • 报警策略
        • 管理报警策略
        • 触发条件
      • 报警通知
        • 报警通知模版
        • 报警回调
      • 报警执行统计
      • 报警历史
    • 数据处理
      • 定时SQL分析
        • 创建定时SQL分析任务
        • 管理定时SQL分析任务
      • 日志投递
        • 日志投递概述
        • 创建投递任务
        • 管理投递任务
      • 数据加工
        • 数据加工函数总览
        • 事件操作函数
        • 字段值提取函数
        • 字段操作函数
        • 映射富化函数
        • 流程控制函数
      • 实时消费
    • 日志应用
      • 智能诊断
    • 多用户访问控制
  • 开发指南
    • API参考
      • API概述
      • 通用说明
      • 名词解释
      • 接口概览
      • 通用错误码
      • 服务域名
      • API功能发布记录
      • 日志组Project相关接口
        • 创建日志组CreateProject
        • 更新日志组UpdateProject
        • 删除日志组DeleteProject
        • 获取日志组列表ListProject
        • 获取日志组详情DescribeProject
      • 日志集LogStore相关接口
        • 创建日志集CreateLogStore
        • 修改日志集UpdateLogStore
        • 删除日志集DeleteLogStore
        • 获取日志集列表ListLogStore
        • 获取日志集详情DescribeLogStore
        • 批量获取日志集BatchGetLogStore
      • 日志流LogStream相关接口
        • 获取日志流列表ListLogStream
      • 日志记录LogRecord相关接口
        • 检索分析日志QueryLogRecord
        • 直方图接口QueryLogHistogram
        • 推送日志PushLogRecord
        • 获取日志记录PullLogRecord
      • 日志视图相关接口
        • 创建日志视图CreateLogStoreView
        • 修改日志视图UpdateLogStoreView
        • 删除日志视图DeleteLogStoreView
        • 获取日志视图列表ListLogStoreView
        • 获取日志视图详情DescribeLogStoreView
      • 下载日志Download相关接口
        • 创建下载任务CreateDownloadTask
        • 删除下载任务DeleteDownloadTask
        • 获取下载任务列表ListDownloadTask
        • 获取下载任务地址GetDownloadTaskLink
        • 获取下载任务详情DescribeDownloadTask
      • 快速查询FastQuery相关接口
        • 创建快速查询CreateFastQuery
        • 更新快速查询UpdateFastQuery
        • 删除快速查询DeleteFastQuery
        • 获取快速查询列表ListFastQuery
        • 获取快速查询详情DescribeFastQuery
      • 传输任务Task相关接口
        • 创建传输任务CreateTask
        • 更新传输任务UpdateTask
      • 报警Alarm相关接口
        • 创建报警策略CreateAlarmPolicy
        • 启用报警策略EnableAlarmPolicy
        • 获取报警历史详情DescribeAlarmRecord
        • 更新报警策略UpdateAlarmPolicy
        • 删除报警策略DeleteAlarmPolicy
        • 获取报警执行列表ListAlarmExecutions
        • 获取报警策略列表ListAlarmPolicy
        • 获取报警策略详情DescribeAlarmPolicy
        • 获取报警执行统计ListAlarmExecutionStats
        • 检验报警策略执行条件ValidateAlarmCondition
        • 禁用报警策略DisableAlarmPolicy
        • 获取报警历史列表ListAlarmRecord
        • 检验报警策略查询语句ValidateAlarmPolicySQL
      • 日志投递LogShipper相关接口
        • 创建日志投递CreateLogShipper
        • 更新日志投递UpdateLogShipper
        • 删除日志投递任务DeleteSingleLogShipper
        • 批量设置日志投递任务状态BulkSetLogShipperStatus
        • 设置日志投递任务状态SetSingleLogShipperStatus
        • 获取日志投递记录ListLogShipperRecord
        • 批量删除日志投递任务BulkDeleteLogShipper
        • 获取日志投递列表ListLogShipper
        • 获取日志投递详情GetLogShipper
      • 日志集模板相关接口
        • 创建日志集模板CreateLogStoreTemplate
        • 更新日志集模板UpdateLogStoreTemplate
        • 删除日志集模板DeleteLogStoreTemplates
        • 获取日志集模板列表DescribeLogStoreTemplates
        • 获取日志集模板详情DescribeLogStoreTemplate
      • 索引Index相关接口
        • 创建索引CreateIndex
        • 更新索引UpdateIndex
        • 删除索引DeleteIndex
        • 获取索引详情DescribeIndex
      • 兼容Elasticsearch相关接口
        • 检索和分析BLS日志 AsyncSearch
        • 查询索引列表 ResolveIndex
        • 推荐字段取值 TermsEnum
        • 获取索引字段列表 FieldCaps
    • SDK参考
      • SDK隐私政策
      • SDK开发者个人信息保护合规指引
      • Android & ISO SDK下载
      • Go SDK
        • 概述
        • 初始化
        • 安装SDK工具包
        • Project操作
        • 日志集LogStore操作
        • 日志流LogStream操作
        • 日志记录LogRecord操作
        • 日志投递LogShipper操作
        • 快速查询FastQuery操作
        • 下载任务操作
        • 索引Index操作
        • 版本发布记录
      • iOS SDK
        • 概述
        • 快速开始
        • 版本发布记录
      • Java SDK
        • 概述
        • 日志记录LogRecord操作
        • 安装SDK工具包
      • Android SDK
        • 概述
        • 快速开始
        • 版本发布记录
    • 导入SLS采集配置
  • 最佳实践
    • 使用同环比作为报警触发条件
    • 通过Grafana使用BLS
    • 使用Grafana访问日志服务的Elasticsearch兼容接口
    • BLS接入Kibana
  • 常见问题
    • 常见问题总览
    • 配置类问题
    • 故障类问题
  • 日志服务等级协议SLA
  • 文档中心
  • arrow
  • 日志服务BLS
  • arrow
  • 开发指南
  • arrow
  • API参考
  • arrow
  • 报警Alarm相关接口
  • arrow
  • 获取报警历史详情DescribeAlarmRecord
本页目录
  • 描述
  • 请求
  • 响应
  • 错误码
  • 示例

获取报警历史详情DescribeAlarmRecord

更新时间:2025-11-14

描述

获取报警历史详情

请求

  • 请求语法
Text
1GET /v1/alarm/record?id=${alarmId} HTTP/1.1
2Host: <Endpoint>
3Authorization: <Authorization String>
4Content-Type: application/json; charset=utf-8
  • 请求头域

除公共请求头域外,无其它特殊头域。

  • 请求参数
参数名称 类型 是否必须 参数位置 描述
alarmId String Yes Path 报警ID

响应

  • 响应头域

除公共响应头域外,无其它特殊头域。

  • 响应参数
字段 类型 描述
success Boolean 请求是否成功
code String 请求码,成功为OK,错误为具体的错误码
message String 请求成功为空,失败为具体的错误信息
alarm Alarm 报警记录详情

Alarm对象的元素结构如下:

字段 类型 描述
id String 报警ID
groupId String 分组ID
startTime String 报警开始时间,UTC时间
endTime String 报警关闭时间,UTC时间,若报警未关闭,该值为空字符串
state String 报警状态,取值:OK: 已恢复, ALERT: 报警中, CLOSED: 已关闭
closeReason String 报警关闭原因, POLICY_MODIFIED: 报警策略更新
policy Policy 报警策略详情
object LogStore 目标日志集,若执行语句共享目标日志集,该字段填写当前报警关联的目标日志集
triggerCondition TriggerCondition 触发报警时的关联的触发条件
groups Map<String, String> 分组结果
executions List<Execution> 执行列表

Policy对象的元素结构如下:

字段 类型 描述
name String 报警策略名称,不能重复
pendingCount Int 连续触发阈值,连续多少次触发阈值则报警
repeatIntervalMinute Int 重复报警间隔,单位:分钟,默认值:0,表示关闭重复报警
recoverWithoutNotice Bool 恢复后是否通知 true:不通知, false:通知, 默认值为false
notices List<Notice> 报警通知模板,参考:BCM通知模板接口

LogStore元素结果如下:

字段 类型 描述
project String 日志集项目,默认default
logStoreName String 日志集名称

targets数组中的每个Target元素结构如下:

参数名称 类型 描述
query String 执行语句
startTimeOffsetMinute Int 查询开始时间偏移量,取值范围: [-1440, 0)
endTimeOffsetMinute Int 取值范围: (startTimeOffsetMinute, 0]
object LogStore 当每个执行语句单独指定日志集时,填写该字段

triggerConditions数组中的每个TriggerCondition元素结构如下:

参数名称 类型 描述
level String 报警等级,必填,可选项:INFO, WARN, CRITICAL
condition String 触发条件表达式

executions数组中的每个Execution元素结构如下:

参数名称 类型 描述
time String 执行时间,UTC时间
state String 执行状态,取值:OK: 恢复正常, ALERT: 报警中
noticeState String 通知状态,取值:NOT_SENT: 未通知, SENT: 已通知,FAIL: 通知发送失败
reason String 若发送失败,填写失败原因
values Map<String, Any> 触发报警时的查询结果数据
notices List<Notice> 报警通知模板,参考:BCM通知模板接口
rawLogs List<RawLog> 报警通知中原始日志

Notice元素结构如下:

参数名称 类型 描述
id String 报警模板id
name String 报警模板名称
members List<String> 报警模板用户列表
methods List<String> 报警模板通知方式,取值:EMAIL: 邮件,SMS: 短信, PHONE: 电话
callbacks List<String> 报警模板回调地址

RawLog元素结构如下:

参数名称 类型 描述
project String 日志集项目
logStoreName String 日志集名称
query String 查询语句
columns List<String> 指定展示字段
limit Int 展示的日志条数
logs List<Map<String, Any>> 展示的日志原文

错误码

除了通用的错误码,无其他特殊错误码返回。


示例

  • 请求示例
Text
1GET /v1/alarm/record?id=a-8aab556f3f7b HTTP/1.1
2Host: bls-log.bj.baidubce.com
3Authorization:bce-auth-v1/18717522d39411e9b721df098b0b908c/2019-09-10T07:00:20Z/1800/content-type;host;x-bce-date;x-bce-request-id/6a7cb6c9ac7ec156c805e55e7d0bcfc443b47feee97cf099c1c0d93a0b4c8304
4Content-Type: application/json; charset=utf-8
5{
6    "pageNo": 1,
7    "pageSize": 10
8}
  • 响应示例
Text
1HTTP/1.1 201
2Content-Type: application/json; charset=utf-8
3X-Bce-Request-Id: 2eeba101-4cc7-4cfe-b5ac-a3be8d060e33
4Date: Fri, 10 Apr 2020 04:42:37 GMT
5{
6    "success": true,
7    "msg": "",  // 若失败,返回失败原因
8    "alarm": {
9        "id": "a-8aab556f3f7b",  //报警ID
10        "groupId": "Y4gLRiPS",  // 分组ID
11        "startTime": "2024-04-10T10:12:30Z",  // 报警开始时间,UTC时间
12        "endTime": "2024-04-10T11:21:31Z",  // 报警关闭时间,UTC时间,若报警未关闭,该值为空字符串
13            
14        // 报警状态,可选项:
15        // OK     - 已恢复
16        // ALERT  - 报警中
17        // CLOSED - 已关闭
18        "state": "ALERT",
19        
20        // 报警关闭原因,可选项:
21        // POLICY_MODIFIED - 报警策略更新
22        "closeReason": "POLICY_MODIFIED",
23        
24        // 关联的报警策略
25        "policy": {
26            "name": "policy-name",  // 策略名称            
27            "pendingCount": 1,  // 连续触发阈值,连续多少次触发阈值则报警            
28            "notices": [],  // 通知列表
29        },
30        
31        // 目标日志集,若执行语句共享目标日志集,该字段填写当前报警关联的目标日志集
32        "object": {
33            "logStoreName": "log-store-test",  // 日志集名称
34        },
35        // 触发报警时的关联的触发条件
36        "triggerCondition": {
37            // 报警等级,可选项:
38            // INFO     - 通知,
39            // WARN     - 警告
40            // CRITICAL - 严重
41            "level": "WARN",
42            
43            // 触发条件表达式
44            "condition": "$1.pv > 100",
45        },
46        // 分组结果
47        "groups": [
48            {"key": "$1.prov", "value": "bj"},
49        ],        
50        // 执行列表
51        "executions": [
52            {
53                "time": "2024-04-10T10:12:30Z",  // 执行时间
54                
55                // 执行状态,可选项:
56                // ALERT - 报警
57                // OK    - 恢复正常可选
58                "state": "ALERT",
59                
60                // 通知状态,可选项:
61                // NOT_SENT - 未通知
62                // SENT     - 已通知
63                // FAIL     - 通知发送失败
64                "noticeState": "SENT",
65                "reason": "",  // 若发送失败,填写失败原因
66                
67                 // 触发报警时的查询结果数据
68                "values": [
69                    {"key": "$1.prov", "value": "bj"},
70                    {"key": "$1.pv", "value": 1000},
71                ],
72                
73                "notices": [
74                    {
75                        "id": "dfa4298f-75e2-4e17-89f6-d41ea98ea196",  // 模板id
76                        "name": "默认通知",  // 模板名称
77                        // 用户列表
78                        "members": ["testUsername"],
79                        // 通知方式,可选项:
80                        // EMAIL - 邮件
81                        // SMS   - 短信
82                        // PHONE - 电话
83                        "methods": ["EMAIL", "SMS", "PHONE"],  
84                        "callbacks": ["http://callback"],  // 回调地址列表
85                    }
86                ],
87                "rawLogs": [
88                    {   
89                        // 日志集项目 
90                        "project" : "default",
91                        // 日志集名称 
92                        "logStoreName" : "bls-router",
93                        // 查询语句 
94                        "query" : "match userId:bbede3f8c42e4113b6971fd09a57f494",
95                        // 指定展示字段
96                        "columns" : ["userId", "requestid", "ip"],  
97                        //最大日志条数
98                        "limit" : 3,  
99                        // 展示的日志原文 
100                        "logs" : [
101                            {
102                                "@timestamp" : 1721898797668,
103                                "userId" : "bbede3f8c42e4113b6971fd09a57f494",
104                                "requestid" : "a-ZC1Zxpxy",
105                                "ip": "127.0.0.1",
106                            }
107                        ]
108                    },
109                    {
110                        "project" : "default",
111                        "logStoreName" : "bls-router",
112                        "query" : "match *",
113                        "columns" : [],  // 若未填写或未空,表示展示全部字段
114                        "limit" : 2,
115                        "logs" : [],
116                    }
117                ]     
118            }
119        ]        
120    }
121}

上一篇
启用报警策略EnableAlarmPolicy
下一篇
更新报警策略UpdateAlarmPolicy