5.3 告警规则管理
5.3.8 查询告警历史
功能介绍
根据告警ID查询告警历史。
调试
您可以在API Explorer中调试该接口。
URI
GET /V1.0/{project_id}/alarm-histories
● 参数说明
表5-52 参数说明
名称 是否必选 说明
project_id 是 项目ID。
获取方式请参见获取项目ID。
group_id 否 服务提供的资源分组功能。创建的资源分组 ID，如：rg1603107497873DK4O2pXbn。
alarm_id 否 告警规则ID。如：
al1603088932912v98rGl1al。
alarm_name 否 告警规则名称：如alarm-test01。
alarm_status 否 告警历史的状态。取值为ok、alarm、
insufficient_data。ok为正常，alarm为告 警，insufficient_data为数据不足。
alarm_level 否 告警历史的告警级别。值为1、2、3、4。其 中1为紧急，2为重要，3为次要，4为提示。
namespace 否 资源命名空间，如弹性云服务器的资源命名空 间为：SYS.ECS，各服务命名空间可查看支持 监控的服务列表。
from 否 查询告警历史的起始时间。UNIX时间戳，单
位毫秒，如：1602501480905。from、to如 果不进行赋值，则默认to是当前时间，from 是当前时间减7天的时间戳。
to 否 查询告警历史的截止时间。UNIX时间戳，单
位毫秒，from必须小于等于to。from、to如 果不进行赋值，则默认to是当前时间，from 是当前时间减7天的时间戳。
名称 是否必选 说明
start 否 分页起始值，类型为integer，默认值为0。
limit 否 单次查询数据的条数限制。取值范围
(0,100]，默认值为100，用于限制结果数据条 数。
● 样例
GET https://{云监控的endpoint}/V1.0/{project_id}/alarm-histories?
limit=10&start=0&from=1602494921346&to=1603099721346&alarm_name=alarm-test01
请求消息
无
响应消息
● 响应参数
名称 参数类型 是
否 必 选
说明
alarm_histo
ries Array of
objects 否 一条或者多条告警历史详细信息。
meta_data MetaDat
a object 否 返回查询结果的总条数。
表5-53 alarm_histories 字段数据结构说明
名称 参数类
型
是否必 选
说明
alarm_id String 否 告警规则的ID，如：
al1603131199286dzxpqK3Ez。
alarm_name String 否 告警规则的名称，如:alarm-test01。
alarm_descrip
tion String 否 告警规则的描述。
metric Metric
object 否 指标信息。
condition Conditi onobject
否 告警规则设置的告警策略。
名称 参数类 型
是否必 选
说明
alarm_level Integer 否 告警历史的告警级别。值为1、2、3、4。
其中1为紧急，2为重要，3为次要，4为提 示。
alarm_type String 否 告警类型。仅针对事件告警的参数，包含 的类型如下：
d Boolea
n 否 告警规则是否被启用，值为true或者 false。
alarm_action
_enabled Boolea
n 否 告警规则的告警触发动作是否被启用，值
为true或者false。
alarm_action
s Array
ofobjects
否 告警触发的动作。 结构如下: { "type":
"notification", "notificationList":
["urn:smn:southchina:
ok_actions Array ofobjects
否 告警恢复触发的动作。 结构如下: { "type":
"notification", "notificationList":
["urn:smn:southchina:
名称 参数类
ata_actions Array ofobjects
否 数据不足触发的动作。结构如下：{ "type":
"notification", "notificationList":
["urn:smn:southchina:
update_time Long 否 告警状态变更的时间。UNIX时间戳，单位 毫秒，例如：1603131199000。
enterprise_pr
oject_id String 否 企业项目ID。 值为all_granted_eps时，表 示所有企业项目；值为0时，表示默认的企 业项目default。
trigger_time Long 否 计算出该条告警历史的时间。UNIX时间 戳，单位毫秒，例如：1603131199469。
alarm_status String 否 告警历史的状态。取值为ok、alarm、
insufficient_data。 ok为正常，alarm为告 警，insufficient_data为数据不足。
datapoints Array ofobjects
否 计算出该条告警历史的监控数据上报时间 和监控数值。
additional_in
fo Additio nalInfo dimensions Arrays
ofobjects
是 指标维度。
metric_nam
e String 是 指标名称。必须以字母开头，只能包含0-9/a-z/A-Z/_，长度最短为1，最大为64。 具体指 标名请参见支持监控的服务列表中查询出的指 标名。
名称 参数类 型
是否 必选
说明
namespace String 是 指标命名空间。例如弹性云服务器命名空间格 式为service.item，service和item必须是字符 串，必须以字母开头，只能包含0-9/a-z/A-Z/_，总长度最短为3，最大为32。
说明当alarm_type为(EVENT.SYS| EVENT.CUSTOM)时 允许为空。
表5-55 dimensions 字段数据结构说明
名称 参数类
value String 否 维度取值，例如弹性云服务器的ID。
长度最短为1，最大为256。
表5-56 alarm_actions 字段数据结构说明
名称 参数类
● notification：通知。
● autoscaling：弹性伸缩。
notificationL
ist Array ofstrings
是 告警状态发生变化时，被通知对象的列表。
说明被通知对象的ID列表的参数类型为字符串，最多可 以配置5个ID。
表5-57 ok_actions 字段数据结构说明
名称 参数类
● notification：通知。
● autoscaling：弹性伸缩。
名称 参数类 型
是否 必选
说明
notification
List Array ofstrings
是 告警状态发生变化时，被通知对象的列表。
说明被通知对象的ID列表的参数类型为字符串，最多可 以配置5个ID。
表5-58 insufficientdata_actions 字段数据结构说明
名称 参数类
型
是否 必选
说明
type String 是 告警通知类型，取值如下：
● notification：通知。
● autoscaling：弹性伸缩。
notificatio
nList Array of
strings 是 告警状态发生变化时，被通知对象的列表。
说明被通知对象的ID列表的参数类型为字符串，最多可 以配置5个ID。
表5-59 condition 字段数据结构说明
名称 参数类
型
是否 必选
说明
period Integer 是 监控数据粒度。
取值范围：
● 1，实时数据
● 300，5分钟粒度
● 1200，20分钟粒度
● 3600，1小时粒度
● 14400，4小时粒度
● 86400，1天粒度
说明当period设置为1时，表示以原始的指标数据判断 告警。当alarm_type为(EVENT.SYS|
EVENT.CUSTOM)时允许为0。
名称 参数类 型
是否 必选
说明
filter String 是 数据聚合方式，支持的聚合方式如下:
● average：聚合周期内指标数据的平均值。
● max：聚合周期内指标数据的最大值。
● min：聚合周期内指标数据的最小值。
● sum：聚合周期内指标数据的求和值。
● variance：聚合周期内指标数据的方差。
comparison_
operator String 是 告警阈值的比较条件，可以是>、=、<、>=、
<=。
value Double 是 告警阈值，取值范围[0, Number.MAX_VALUE]，
unit String 否 数据的单位，最大长度为32位。
count Integer 是 触发告警连续发生次数，取值范围[1, 5]。
suppress_du
ration Integer 否 发送告警的周期。值可为0、300、600、
900、1800、3600、10800、21600、
表5-60 datapoints 字段数据结构说明
名称 参数类
表5-61 additional_info 字段数据结构说明
resource_id String 否 该条告警历史对应的资源ID，如：
22d98f6c-16d2-4c2d-b424-50e79d82838f。
resource_na
me String 否 该条告警历史对应的资源名称，如：ECS-Test01。
event_id String 否 该条告警历史对应的事件ID，如：
ev16031292300990kKN8p17J。
表5-62 meta_data 字段数据结构说明
名称 参数类型 是否必
选
说明
total Integer 是 结果总条数。
● 响应样例
{ "alarm_histories": [
{ "alarm_id": "al1604473987569z6n6nkpm1",
"alarm_name": "TC_CES_FunctionBaseline_Alarm_008", "alarm_description": "",
"metric": {
"namespace": "SYS.VPC", "dimensions": [
{
"name": "bandwidth_id",
"value": "79a9cc0c-f626-4f15-bf99-a1f184107f88"
} ],
"metric_name": "downstream_bandwidth"
},
"condition": { "period": 1, "filter": "average",
"comparison_operator": ">=", "value": 0,
"count": 3 },
"alarm_level": 2, "alarm_type": "", "alarm_enabled": false, "alarm_action_enabled": false, "alarm_actions": [],
"ok_actions": [],
"insufficientdata_actions": [], "update_time": 1604473988000, "enterprise_project_id": "0", "trigger_time": 1604473987607, "alarm_status": "alarm", "datapoints": [
"time": 1604473800000,
{ "alarm_id": "al1604473978613MvlvlbVZD", "alarm_name": "alarm_merge",
"alarm_description": "", "metric": {
"namespace": "AGT.ECS", "dimensions": [
{
"name": "instance_id",
"value": "22d98f6c-16d2-4c2d-b424-50e79d82838f"
} ],
"metric_name": "load_average5",
"resource_group_id": "rg160447397837330303XQbK", "resource_group_name": "group1"
},
"condition": { "period": 1, "filter": "average",
"comparison_operator": ">=", "value": 0,
"count": 3 },
"alarm_level": 2,
"alarm_type": "RESOURCE_GROUP", "alarm_enabled": false,
"alarm_action_enabled": false, "alarm_actions": [],
"ok_actions": [],
"insufficientdata_actions": [], "update_time": 1604473979000, "enterprise_project_id": "0", "trigger_time": 1604473979070, "alarm_status": "insufficient_data", "datapoints": [],
"meta_data": { "total": 2
返回值 说明 400 Bad Request 请求错误。
401 Unauthorized 未提供认证信息，或认证信息错误。
403 Forbidden 请求页面被禁止访问。
408 Request Timeout 请求超出了服务器的等待时间。
429 Too Many
Requests 当前请求过多。
500 Internal Server
Error 请求未完成，服务异常。
503 Service
Unavailable 系统暂时不可用，请求受限。
错误码
请参考返回错误码说明。