更新时间:2024-01-04 GMT+08:00

查询告警历史

功能介绍

根据告警ID查询告警历史。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /V1.0/{project_id}/alarm-histories

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    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_histories

    Array of objects

    一条或者多条告警历史详细信息

    详细参数说明请参见表2

    meta_data

    MetaData object

    返回查询结果的总条数。

    详细参数说明请参见表11

    表2 alarm_histories字段数据结构说明

    名称

    参数类型

    是否必选

    说明

    alarm_id

    String

    告警规则的ID,如:al1603131199286dzxpqK3Ez。

    alarm_name

    String

    告警规则的名称,如:alarm-test01。

    alarm_description

    String

    告警规则的描述。

    metric

    Metric object

    指标信息。

    详细参数说明请参见表3

    condition

    Condition object

    告警规则设置的告警策略。

    详细参数说明请参见表8

    alarm_level

    Integer

    告警历史的告警级别。值为1、2、3、4。其中1为紧急,2为重要,3为次要,4为提示。

    alarm_type

    String

    告警类型。仅针对事件告警的参数,包含的类型如下:

    EVENT.SYS:系统事件告警

    EVENT.CUSTOM:自定义事件告警

    DNSHealthCheck:DNS健康检查告警

    RESOURCE_GROUP:资源分组告警

    MULTI_INSTANCE:指定资源告警

    alarm_enabled

    Boolean

    告警规则是否被启用,值为true或者false。

    alarm_action_enabled

    Boolean

    告警规则的告警触发动作是否被启用,值为true或者false。

    alarm_actions

    Array of objects

    告警触发的动作。 结构如下: { "type": "notification", "notificationList": ["urn:smn:southchina:68438a86d98e427e907e0097b7e35d47:sd"] }

    type可取值如下:

    notification:通知。

    autoscaling:弹性伸缩。

    notificationList:告警状态发生变化时,被通知对象的列表。

    详细参数说明请参见表5

    ok_actions

    Array of objects

    告警恢复触发的动作。 结构如下: { "type": "notification", "notificationList": ["urn:smn:southchina:68438a86d98e427e907e0097b7e35d47:sd"] }

    type可取值如下:

    notification:通知。

    notificationList:告警状态发生变化时,被通知对象的列表。

    详细参数说明请参见表6

    insufficientdata_actions

    Array of objects

    数据不足触发的动作。结构如下:{ "type": "notification", "notificationList": ["urn:smn:southchina:68438a86d98e427e907e0097b7e35d47:sd"] }

    type可取值如下:

    notification:数据不足触发告警通知。

    notificationList:数据不足触发告警通知时,被通知对象的ID列表。

    详细参数说明请参见表7

    update_time

    Long

    告警状态变更的时间。UNIX时间戳,单位毫秒,例如:1603131199000。

    enterprise_project_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 of objects

    计算出该条告警历史的监控数据上报时间和监控数值。

    详细参数说明请参见表9

    additional_info

    AdditionalInfo object

    告警历史额外字段,仅针对事件监控告警场景所产生的告警历史信息。

    详细参数说明请参见表10

    表3 metric字段数据结构说明

    名称

    参数类型

    是否必选

    说明

    dimensions

    Array of objects

    指标维度。

    详细参数说明请参见表4

    metric_name

    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)时允许为空。

    表4 dimensions字段数据结构说明

    名称

    参数类型

    是否必选

    说明

    name

    String

    监控维度名称,例如弹性云服务器的维度为instance_id。各服务维度请参考支持监控的服务列表,可参考维度中key字段。

    value

    String

    维度取值,例如弹性云服务器的ID。

    长度最短为1,最大为256。

    表5 alarm_actions字段数据结构说明

    名称

    参数类型

    是否必选

    说明

    type

    String

    告警通知类型,取值如下:
    • notification:通知。
    • autoscaling:弹性伸缩。

    notificationList

    Array of strings

    告警状态发生变化时,被通知对象的列表。

    说明:

    被通知对象的ID列表的参数类型为字符串,最多可以配置5个ID。

    表6 ok_actions字段数据结构说明

    名称

    参数类型

    是否必选

    说明

    type

    String

    告警通知类型,取值如下:
    • notification:通知。
    • autoscaling:弹性伸缩。

    notificationList

    Array of strings

    告警状态发生变化时,被通知对象的列表。

    说明:

    被通知对象的ID列表的参数类型为字符串,最多可以配置5个ID。

    表7 insufficientdata_actions字段数据结构说明

    名称

    参数类型

    是否必选

    说明

    type

    String

    告警通知类型,取值如下:
    • notification:通知。
    • autoscaling:弹性伸缩。

    notificationList

    Array of strings

    告警状态发生变化时,被通知对象的列表。

    说明:

    被通知对象的ID列表的参数类型为字符串,最多可以配置5个ID。

    表8 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],Number.MAX_VALUE值为1.7976931348623157e+108。

    具体阈值取值请参见附录中各服务监控指标中取值范围,如支持监控的服务列表中ECS的CPU使用率cpu_util取值范围可配置80。

    unit

    String

    数据的单位,最大长度为32位

    count

    Integer

    触发告警连续发生次数,取值范围[1, 5]

    suppress_duration

    Integer

    发送告警的周期。值可为0、300、600、900、1800、3600、10800、21600、43200、86400。0表示只告警一次,300表示每5分钟告警一次,600表示每10分钟告警一次,900表示每15分钟告警一次,1800表示每30分钟告警一次,3600表示每1小时告警一次,10800表示每3小时告警一次,21600表示每6小时告警一次,43200表示每12小时告警一次,86400表示每1天告警一次。

    表9 datapoints字段数据结构说明

    名称

    参数类型

    是否必选

    说明

    time

    Long

    计算出该条告警历史的监控数据上报时间,UNIX时间戳,单位毫秒,如:1603131028000。

    value

    Double

    计算出该条告警历史的监控数值,如:7.019。

    表10 additional_info字段数据结构说明

    名称

    参数类型

    是否必选

    说明

    resource_id

    String

    该条告警历史对应的资源ID,如:22d98f6c-16d2-4c2d-b424-50e79d82838f。

    resource_name

    String

    该条告警历史对应的资源名称,如:ECS-Test01。

    event_id

    String

    该条告警历史对应的事件ID,如:ev16031292300990kKN8p17J。

    表11 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": 1604473860000,
             "value": 0
           },
           {
             "time": 1604473800000,
             "value": 0
           },
           {
             "time": 1604473740000,
             "value": 0
           }
         ],
         "additional_info": {
           "resource_id": "",
           "resource_name": "",
           "event_id": ""
         }
       },
       {
         "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": [],
         "additional_info": {
           "resource_id": "",
           "resource_name": "",
           "event_id": ""
         }
       }
     ],
     "meta_data": {
       "total": 2
     }
    }

返回值

  • 正常

    200

  • 异常

    返回值

    说明

    400 Bad Request

    请求错误。

    401 Unauthorized

    未提供认证信息,或认证信息错误。

    403 Forbidden

    请求页面被禁止访问。

    408 Request Timeout

    请求超出了服务器的等待时间。

    429 Too Many Requests

    当前请求过多。

    500 Internal Server Error

    请求未完成,服务异常。

    503 Service Unavailable

    系统暂时不可用,请求受限。

错误码

请参考返回错误码说明