获取报警策略列表ListAlarmPolicy

日志服务 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
  • 获取报警策略列表ListAlarmPolicy
本页目录
  • 描述
  • 请求
  • 响应
  • 错误码
  • 示例

获取报警策略列表ListAlarmPolicy

更新时间:2025-11-14

描述

获取报警策略列表

请求

  • 请求语法
Text
1POST /v1/alarm/policy/list HTTP/1.1
2Host: <Endpoint>
3Authorization: <Authorization String>
4Content-Type: application/json; charset=utf-8
5{
6    "policyNamePattern": "policy-name"
7}
  • 请求头域

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

  • 请求参数
参数名称 类型 是否必须 参数位置 描述
policyNamePattern String No RequestBody 按策略名称过滤
policyIdPattern String No RequestBody 按策略ID过滤
logStoreNamePattern String No RequestBody 按日志集过滤
state String No RequestBody 按策略状态过滤, 取值:ENABLE, DISABLED
noticeState String No RequestBody 按通知状态过滤,取值:ENABLE, DISABLED
orderBy String No RequestBody 排序字段,createdTime: 创建时间, updatedTime: 更新时间,默认值:updatedTime
order String No RequestBody 排序方式,asc: 升序, desc: 降序,默认值:desc
pageNo Int Yes RequestBody 第几页,从1开始计数
pageSize Int Yes RequestBody 每页展示数量,最大值:100

响应

  • 响应头域

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

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

Result对象的元素结构如下:

字段 类型 描述
policies List<Policy> 报警策略列表
pageNo Int 第几页
pageSize Int 每页展示数量
totalCount Int 总数

Policy对象的元素结构如下:

字段 类型 描述
id String 报警策略ID,唯一
name String 报警策略名称,不能重复
objects List<LogStore> 监控对象列表,当所有日志集共享目标日志集时,填写该字段
targets List<Target> 执行语句列表
triggerConditions List<TriggerCondition> 触发条件列表
groups List<String> 分组触发
schedule Schedule 执行周期
pendingCount Int 连续触发阈值,连续多少次触发阈值则报警
repeatIntervalMinute Int 重复报警间隔,单位:分钟,默认值:0,表示关闭重复报警
recoverWithoutNotice Bool 恢复后是否通知 true:不通知, false:通知, 默认值为false
state String 策略启用状态,ENABLED: 已启用, DISABLED: 已禁用
noticeState String 下通知启用状态,ENABLED: 已启用, DISABLED: 已禁用
notices List<Notice> 报警通知模板,参考:BCM通知模板接口
noticeRawLogs List<NoticeRawLog> 是否在报警通知中添加原始日志

其中,objects数组中的每个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 触发条件表达式

Schedule元素结构如下:

参数名称 类型 描述
intervalMinute Int 固定间隔,单位:分钟,取值范围[1, 1440]
fixTimeMinute Int 指定时刻,一天中的第几分钟,取值范围[0, 1440)
dayOfWeek Int 固定时间频率; 0: 每天,1~7 一周的某天

Notice元素结构如下:

参数名称 类型 描述
id String bcm报警模板id

NoticeRawLog元素结构如下:

参数名称 类型 描述
type String 配置类型, REF: 关联执行语句, CUSTOM: 自定义检索语句
refTarget String 若type=REF,表示引用的执行语句序号,从0开始计数
customTarget Target 若type=CUSTOM,填写自定义执行语句
columns List<String> 在原始日志中展示的字段名列表,若未填写,表示展示所有字段
limit Int 展示的日志条数,最大值为5

错误码

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


示例

  • 请求示例
Text
1POST /v1/alarm/policy/list 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    "code": "OK",  // 错误码
8    "message": "",  // 错误详情
9    "result": {
10        "pageNo": 1,  // 第几页
11        "pageSize": 10,  // 每页展示数量
12        "totalCount": 100,  // 总数
13        "policies": {
14            // 报警策略名称,同user下唯一
15            "name": "policy-name",
16
17            // 策略ID,同user下唯一
18            "id": "p-nRyKJOpr",
19
20            // 策略启用状态,可选项:
21            // ENABLED  - 已启用
22            // DISABLED - 已禁用
23            "state": "ENABLED",
24
25            // 通知启用状态,可选项:
26            // ENABLED  - 已启用
27            // DISABLED - 已禁用
28            "noticeState": "ENABLED",
29
30            // 通知启用状态,可选项
31            // ENABLED  - 已启用
32            // DISABLED - 已禁用
33            "noticeState": "ENABLED",
34
35            "createdTime": "20240410T10:12:30Z",  // 创建时间,UTC时间 
36            "updatedTime": "20240410T10:12:30Z",  // 更新时间,UTC时间
37
38            // 监控对象列表,当所有日志集共享目标日志集时,该字段被填充
39            "objects": [
40                {
41                    "logStoreName": "test-logstore-52"  // 日志集名称
42                },
43            ],
44
45            // 执行语句列表
46            "targets": [
47                {
48                    // 执行语句
49                    "query": "select sum(age) as age",
50                    // 查询开始时间偏移量,必填,取值范围: [-1440, 0)
51                    "startTimeOffsetMinute": -1440,
52                    // 查询结束时间偏移量,必填,取值范围: (startTimeOffsetMinute, 0]
53                    "endTimeOffsetMinute": 0,
54
55                    // 目标日志集,当每个执行语句单独指定日志集时,该字段被填充
56                    "object": {
57                        "logStoreName": "test-logstore-52"  // 日志集名称
58                    }
59                }
60            ],
61
62            // 触发条件列表
63            "triggerConditions": [
64                {
65                    // 报警等级,可选项:
66                    // INFO     - 通知,
67                    // WARN     - 警告
68                    // CRITICAL - 严重
69                    "level": "WARN",
70
71                    // 触发条件表达式
72                    "condition": "$1.age > 1"
73                }
74            ],
75
76            // 分组触发
77            "groups": ["$1.age", "$1.salary"],
78
79            // 执行周期,固定间隔和指定时刻有且仅有一个被设置
80            "schedule": {
81                // 固定间隔,单位:分钟,取值范围[1, 1440]
82                "intervalMinute": 1,
83
84                // 指定时刻,一天中的第几分钟,取值范围[0, 1440)
85                "fixTimeMinute": 120, // 示例中,120表示一天中的第120分钟,即凌晨2点整
86
87                // 固定时间频率; 0: 每天  1~7 一周的周一到周日
88                "dayOfWeek": 3,
89            },
90
91            // 连续触发阈值,连续多少次触发阈值则报警
92            "pendingCount": 1,
93
94            // 重复报警间隔,单位:分钟,默认值:0,表示关闭重复报警
95            "repeatIntervalMinute": 5,
96
97            // 恢复后是否通知 true:通知, false:不通知, 默认
98            "recoverAlarmNotice": true,
99
100            // 报警通知模板列表
101            "notices": [
102                {
103                    // bcm报警模板id
104                    "id": "testNotice"  
105                }
106            ],
107
108             // 报警内容是否增加日志原文 false:不增加,默认 true:增加
109            "noticeWithRawLog" : true,
110
111            // 报警通知内容配置
112            "noticeRawConfigs" : [
113                {    
114                    // 配置类型,必填
115                    // REF  自动关联执行语句
116                    // CUSTOM   自定义检索语句
117                    "type" : "CUSTOM",
118
119                    // 若type为REF,表示执行语句序号
120                    "refTarget" : 1,
121
122                    // 若type为AUTO_ASSOCIATED,表示自定义检索语句
123                    "query" : "match *",
124
125                    // 如果每个执行语句单独选择日志集,且配置为自定义检索语句,这里表示日志集
126                    "object" : {
127                        // 日志集项目,必填
128                        "project" : "default",
129                        // 日志集名,必填
130                        "logStoreName" : "bls-ng-log"
131                    },
132                    // 显示字段,必填写
133                    // All - 所有字段
134                    // SpecifiedFields - 指定字段
135                    "displayType" : "ALL",
136
137                    // 指定字段名列表,选填
138                    "display_fields" : ["requestid", "status"],
139                    // 表示展示的日志条数,最大值为5
140                    "limit" : 4,
141                }
142            ]
143        }
144    }
145}

上一篇
获取报警执行列表ListAlarmExecutions
下一篇
获取报警策略详情DescribeAlarmPolicy