告警查询

显示告警的详细信息

URI

GET /v2/alarms/{alarm_id}

请求参数

名称	是否可选	类型	描述
alarm_id	否	String	告警的UUID

响应参数

名称	输入	类型	描述
alarm_actions	body	array	警报执行的操作列表。
alarm_id	body	String	告警的UUID
combination_rule	body	String	组合警报类型的规则。
description	body	String	告警描述
enabled	body	boolean	告警开关
insufficient_data_actions	body	array	警报状态不足时警报执行的操作列表。
timestamp	body	String	告警时间
name	body	String	告警名称
ok_actions	body	array	警报状态正常时，警报将执行的操作的列表。
state_timestamp	body	String	告警状态的时间
threshold_rule	body	String	阈值警报类型的规则。
repeat_actions	body	boolean	如果设置为true，则重复警报通知。 否则，该值为false。
state	body	String	告警状态
type	body	String	警报的类型，可以是阈值或组合。
user_id	body	String	创建或最后更新资源的用户的UUID。

正常响应代码

200

更新告警

URI

PUT /v2/alarms/{alarm_id}

请求参数

名称	是否可选	类型	描述
alarm_id	否	String	告警的UUID
alarm	是	String	请求正文中的需要修改的告警信息。

响应参数

名称	输入	类型	描述
alarm_actions	body	array	警报执行的操作列表
alarm_id	body	String	告警的UUID
combination_rule	body	String	组合警报类型的规则
description	body	String	告警描述
enabled	body	boolean	告警开关
insufficient_data_actions	body	array	警报状态不足时警报执行的操作列表
timestamp	body	String	告警时间
name	body	String	告警名称
ok_actions	body	array	警报状态正常时，警报将执行的操作的列表
state_timestamp	body	String	告警状态的时间
threshold_rule	body	String	阈值警报类型的规则
repeat_actions	body	boolean	如果设置为true，则重复警报通知。 否则，该值为false
state	body	String	告警状态
type	body	String	警报的类型，可以是阈值或组合
user_id	body	String	创建或最后更新资源的用户的UUID

正常响应代码

200

删除告警

功能介绍

按告警ID删除告警。

URI

DELETE /v2/alarms/{alarm_id}

请求参数

名称	是否可选	类型	描述
alarm_id	否	String	告警的UUID

正常响应代码

204

更新告警状态

功能介绍

设置告警的状态。

URI

PUT /v2/alarms/{alarm_id}/state

请求参数

名称	是否可选	类型	描述
alarm_id	否	String	告警的UUID
state	是	String	告警状态

正常响应代码

200

显示告警状态

功能介绍

通过告警ID显示告警的状态。

URI

GET /v2/alarms/{alarm_id}/state

请求参数

名称	是否可选	类型	描述
alarm_id	否	String	告警的UUID

正常响应代码

200

列举所有告警

功能介绍

使用查询条件列举告警。

URI

GET /v2/alarms

请求参数

名称	是否可选	类型	描述
q	是	array	按一个或多个参数过滤响应。 例如：？q.field = Foo和q.value = my_text。

响应参数

名称	输入	类型	描述
alarm_actions	body	array	警报执行的操作列表
description	body	String	告警描述
timestamp	body	String	告警时间
combination_rule	body	String	组合警报类型的规则
alarm_id	body	String	告警的UUID
state	body	String	告警状态
insufficient_data_actions	body	array	警报状态不足时警报执行的操作列表
user_id	body	String	创建或最后更新资源的用户的UUID
project_id	body	String	拥有资源的项目或租户的UUID
type	body	String	监控项类型
name	body	String	告警名称

正常响应代码

200

创建告警

功能介绍

创建一个告警。

URI

POST /v2/alarms

请求参数

名称	是否可选	类型	描述
name	否	String	名称
type	否	String	类型
description	是	String	描述
metric	否	String	监控项
threshold	否	float	阈值
comparison-operator	否	String	比较方式
aggregation-methed	否	String	聚合方法
granularity	否	integer	采集周期
evaluation-period	否	integer	监控周期
alarm-action	否	String	告警发生后行为
resource-id	否	String	资源ID
resource-type	否	String	资源类型

响应参数

名称	输入	类型	描述
alarm_actions	body	array	警报执行的操作列表
alarm_id	body	String	告警的UUID
combination_rule	body	String	组合警报类型的规则
description	body	String	告警描述
enabled	body	boolean	告警开关
insufficient_data_actions	body	array	警报状态不足时警报执行的操作列表
timestamp	body	String	告警时间
name	body	String	告警名称
ok_actions	body	array	警报状态正常时，警报将执行的操作的列表
state_timestamp	body	String	告警状态的时间
threshold_rule	body	String	阈值警报类型的规则
repeat_actions	body	boolean	如果设置为true，则重复警报通知。 否则，该值为false
state	body	String	告警状态
type	body	String	警报的类型，可以是阈值或组合
user_id	body	String	创建或最后更新资源的用户的UUID

正常响应代码

200

显示告警历史

功能介绍

通过报警ID，组装并显示报警的历史。

URI

GET /v2/alarms/{alarm_id}/history

请求参数

名称	是否可选	类型	描述
alarm_id	否	String	告警的UUID
q	是	array	按一个或多个参数过滤响应。 例如：？q.field = Foo和q.value = my_text

正常响应代码

200

修订记录

日期	修订内容
2021-02-03	第一次正式发布。