报警策略列表接口
更新时间：2025-04-02
接口描述
该接口可获取云产品监控、站点监控等相关报警的报警策略列表信息。
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | RequestBody参数 |
| scope | String | 云产品名字空间，仅限于使用如下字符集合："0~9、A~Z、a~z"、 "_" | 是 | RequestBody参数 |
| region | String | 地域，默认为bj | 否 | RequestBody参数 |
| dimensions | String | 维度，由dimensionName:dimensionValue组成。当监控项具备多个维度时使用分号连接，例如dimensionName:dimensionValue;dimensionName:dimensionValue，相同维度只能指定一个维度值 | 否 | RequestBody参数 |
| order | String | 排序方式 | 是 | RequestBody参数 |
| pageSize | int | 每页数量 | 是 | RequestBody参数 |
| pageNo | int | 第几页 | 是 | RequestBody参数 |
| actionEnabled | boolean | 是否已启用 | 否 | RequestBody参数 |
参数解释
- 名字空间scope、指标metric、统计方法Statistic、维度Dimension等的概念请参考核心概念。
返回字段说明
| 类型 | 描述 |
|---|---|
| PageResultResponse<AlarmConfig> | 报警策略列表 |
请求示例
Python
1HOST = 'http://bcm.bj.baidubce.com/'
2AK = 'ALTA****************3hVCYG'
3SK = 'b2c53***********************3ac1'
4config = BceClientConfiguration(credentials=BceCredentials(AK, SK), endpoint=HOST)
5
6resp = self.client.get_single_instance_alarm_configs(user_id, "BCE_BCC", 1, 10)
7print(resp)
8 附录
AlarmConfig
| 名称 | 类型 | 描述 |
|---|---|---|
| alarmDescription | String | 自动生成，报警规则说明 |
| alarmName | String | userId下唯一报警名 |
| aliasName | String | 前端展示使用，允许重复 |
| userId | String | 用户id |
| scope | String | 所属云产品名字空间 |
| region | String | 地域 |
| monitorObject | MonitorObject | 监控对象 |
| type | AlarmType(enum) | 报警类型，可选值为： NORMAL（指标报警） EVENT（事件报警） |
| eventTypeList | List< String > | 事件类型列表 |
| level | AlarmLevel(enum) | 报警等级，可选值为： NOTICE（通知） WARNING（警告） MAJOR（重要） CRITICAL（严重） |
| actionEnabled | Boolean | 报警的通知状态 |
| rules | List< List<AlarmRule> > | 报警规则列表 |
| alarmActions | Set< String > | 报警状态下所要采取的动作 |
| okActions | Set< String > | 正常状态下所要采取的动作 |
| insufficientActions | Set< String > | 采集数据不足状态下的动作 |
| insufficientCycle | int | 无数据报警判断周期 |
| srcName | String | 实例组id |
| srcType | String | 实例组类型 |
| repeatAlarmCycle | int | 重复报警周期 |
| maxRepeatCount | int | 最大的报警重复次数 |
| callbackUrl | String | 报警回调地址 |
| callbackToken | String | 报警回调token |