# 查询告警历史 - ListAlarmHistories #### 功能介绍 查询告警历史列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CES/doc?api=ListAlarmHistories&version=v1)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ces/ces_03_0045.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | ces:alarmHistory:list | List | - | g:EnterpriseProjectId | - | - | #### URI GET /V1.0/{project_id}/alarm-histories 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-ces/ces_03_0057.html)。 **约束限制**: 不涉及。 **取值范围**: 长度为\[1,64\]个字符。 **默认取值**: 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | group_id | 否 | String | **参数解释**： 当前资源所在分组信息 **约束限制**： 不涉及。 **取值范围**： 以rg开头，后跟22位由字母或数字组成的字符串，字符长度为24 **默认取值**： 不涉及 | | alarm_id | 否 | String | **参数解释**： 告警规则ID **约束限制**： 不涉及 **取值范围**： 以al开头，后跟22位由字母或数字组成的字符串，字符长度为24 **默认取值**： 不涉及 | | alarm_name | 否 | String | **参数解释**： 告警规则名称 **约束限制**： 不涉及 **取值范围**： 只能包含0-9/a-z/A-Z/_/-或汉字，长度\[1, 128\]个字符 **默认取值**： 不涉及 | | alarm_status | 否 | String | **参数解释**： 告警状态。 **约束限制**： 不涉及 **取值范围**： 枚举值： - ok：正常 - alarm：告警 - insufficient_data：数据不足 - invalid：已失效 **默认取值**： 不涉及 | | alarm_level | 否 | Integer | **参数解释**： 告警历史的告警级别，值为1,2,3,4 **约束限制**： 不涉及 **取值范围**： 枚举值： - 1：紧急 - 2：重要 - 3：次要 - 4：提示 **默认取值**： 不涉及 | | namespace | 否 | String | **参数解释**： 查询服务的命名空间，各服务命名空间请参阅[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)。 **约束限制**： 不涉及 **取值范围**： 格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。字符串的长度必须在 3 到 32个字符之间 **默认取值**： 不涉及 | | from | 否 | String | **参数解释**： 通过时间筛选traces的起始时间(包括传入时间)，为timestamp **约束限制**： 不涉及 **取值范围**： 长度为\[1,13\]个字符 **默认取值**： 不涉及 | | to | 否 | String | **参数解释**： 通过时间筛选traces的终止时间(包括传入时间)，为timestamp **约束限制**： 不涉及 **取值范围**： 长度为\[1,13\]个字符 **默认取值**： 不涉及 | | start | 否 | String | **参数解释**： 分页查询时查询的起始位置，表示从第几条数据开始 **约束限制**： 不涉及。 **取值范围**： 大于等于0的整数 **默认取值**： 0 | | limit | 否 | String | **参数解释**： 本次查询的最大条目数 **约束限制**： 不涉及。 **取值范围**： 取值范围\[1,100\] **默认取值**： 100 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 否 | String | **参数解释**: 发送的实体的MIME类型。 **约束限制**: 不涉及。 **取值范围**: 长度为\[1,64\]个字符。 **默认取值**: 默认使用 application/json; charset=UTF-8，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 | | X-Auth-Token | 否 | String | **参数解释**: 用户Token。 **约束限制**: 不涉及。 **取值范围**: 长度为\[1,16384\]个字符。 **默认取值**: 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | alarm_histories | Array of [AlarmHistoryInfoResp] objects | **参数解释**： 一条或者多条告警历史详细信息 | | meta_data | [MetaDataForAlarmHistoryResp] object | **参数解释** 查询告警历史返回的总条数。 | 表5AlarmHistoryInfoResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | alarm_id | String | **参数解释**： 告警规则的ID，如：al1603131199286dzxpqK3Ez。 **取值范围**： 字符串长度为24 | | alarm_name | String | **参数解释**： 告警规则的名称，如：alarm-test01 **取值范围**： 字符串长度在 1 到 128 之间 | | alarm_description | String | **参数解释**： 告警规则的描述 **取值范围**： 字符串长度在 0 到 256 之间 | | metric | [MetricInfoResp] object | **参数解释**： 指标信息 | | condition | [ConditionResp] object | **参数解释**： 告警规则设置的告警策略。 | | alarm_level | Integer | **参数解释**： 告警记录的告警级别。 **取值范围**： 枚举值： - 1：紧急 - 2：重要 - 3：次要 - 4：提示 | | alarm_type | String | **参数解释**： 告警规则类型 **取值范围**： 枚举值: - ALL_INSTANCE：全部资源指标告警 - RESOURCE_GROUP：资源分组指标告警 - MULTI_INSTANCE：指定资源指标告警 - EVENT.SYS：系统事件告警 - EVENT.CUSTOM：自定义事件告警 - DNSHealthCheck：健康检查告警 | | alarm_enabled | Boolean | **参数解释**： 告警规则是否被启用 **取值范围**： 值为true或者false - true：开启 - false：关闭 | | alarm_action_enabled | Boolean | **参数解释**： 是否发送通知 **取值范围**： 值为true或者false - true：发送通知 - false：不发送通知 | | alarm_actions | Array of [AlarmActionsResp] objects | **参数解释**： 告警触发时，通知组/主题订阅的信息。结构如下：{ "type": "notification", "notificationList": \["urn:smn:southchina:68438a86d98e427e907e0097b7e35d47:sd"\] } | | ok_actions | Array of [AlarmActionsResp] objects | **参数解释**： 告警恢复时，通知组/主题订阅的信息。结构如下：{ "type": "notification", "notificationList": \["urn:smn:southchina:68438a86d98e427e907e0097b7e35d47:sd"\] } | | insufficientdata_actions | Array of [AlarmActionsResp] objects | **参数解释**： 数据不足时触发告警时，通知组/主题订阅的信息。结构如下：{ "type": "notification", "notificationList": \["urn:smn:southchina:68438a86d98e427e907e0097b7e35d47:sd"\] } | | update_time | Long | **参数解释**： 告警状态变更的时间，UNIX时间戳，单位毫秒，如：1603131199000 **取值范围**： 不涉及 | | enterprise_project_id | String | **参数解释**： 企业项目ID **取值范围**： 只能包含小写字母、数字、"-"、"_"，可以自定义企业项目ID，长度为36个字符。也可以为0（代表默认企业项目ID），all_granted_eps（代表所有企业项目ID） | | trigger_time | Long | **参数解释**： 计算出该条告警历史的时间，UNIX时间戳，单位毫秒，如：1603131199469 **取值范围**： 不涉及 | | alarm_status | String | **参数解释**： 告警规则的状态 **取值范围**： 枚举值： - ok：正常 - alarm：告警 - insufficient_data：数据不足 - invalid：已失效 | | datapoints | Array of [DataPointForAlarmHistoryResp] objects | **参数解释**： 计算出该条告警历史的资源监控数据的一组数据上报时间和监控数值 | | additional_info | [AdditionalInfoResp] object | **参数解释** 告警历史额外字段，仅针对事件监控告警场景所产生的告警历史信息。 | | notification_manner | String | **参数解释** 通知方式 **取值范围**： 枚举值： - NOTIFICATION_POLICY：通知策略 - NOTIFICATION_GROUP：通知组 - TOPIC_SUBSCRIPTION：主题订阅 | 表6MetricInfoResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | namespace | String | **参数解释**： 服务指标命名空间。 **取值范围**： 字符长度 3 - 32 之间 | | metric_name | String | **参数解释**： 资源的监控指标名称。 **取值范围**： 字符长度 1 - 96 之间 | | dimensions | Array of [MetricsDimension] objects | **参数解释** 指标维度 | 表7MetricsDimension | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释** 资源维度，如：弹性云服务器，则维度为instance_id；目前最大支持4个维度，各服务资源的维度名称，请参阅具体云服务的文档。您可以直接从[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)页面导航至相应文档。 **取值范围** 由字母开头，后面可以包含字母、数字、_或-，长度为\[1,32\]个字符 | | value | String | **参数解释** 资源维度值，为资源的实例ID，如：4270ff17-aba3-4138-89fa-820594c39755。 **取值范围** 长度为\[1,256\]个字符 | 表8ConditionResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | comparison_operator | String | **参数解释**： 阈值符号。 **取值范围**： 支持的值为(\>\|\<\|\>=\|\<=\|=\|!=\|cycle_decrease\|cycle_increase\|cycle_wave);cycle_decrease为环比下降,cycle_increase为环比上升,cycle_wave为环比波动。 | | count | Integer | **参数解释**： 触发告警的连续发生次数。 **取值范围**： 整数，取值范围\[1, 5\]。 | | filter | String | **参数解释**： 数据聚合的方式。 **取值范围**： 支持 average、variance、min、max、sum。 - average： 平均值 - variance：方差 - min：最小值 - max：最大值 - sum：求和 | | period | Integer | **参数解释**： 指标周期，单位是秒。如想了解各个云服务的指标原始周期可以参考[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)**取值范围** ： - 0代表立即触发，仅限事件场景使用。 - 1代表指标的原始周期，比如RDS监控指标原始周期是60s，表示该RDS指标按60s周期为一个数据点参与告警计算。 - 300代表指标按5分钟聚合周期为一个数据点参与告警计算。 - 1200代表指标按20分钟聚合周期为一个数据点参与告警计算。 - 3600代表指标按1小时聚合周期为一个数据点参与告警计算。 - 14400代表指标按4小时聚合周期为一个数据点参与告警计算。 - 86400代表指标按1天聚合周期为一个数据点参与告警计算。 枚举值。 | | unit | String | **参数解释**： 数据的单位。 **取值范围**： 长度为\[0,32\]个字符。 | | value | Number | **参数解释**： 告警阈值。具体阈值取值请参见附录中各服务监控指标中取值范围，如[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)中ECS的CPU使用率cpu_util取值范围可配置80。 **取值范围**： 最小值为-1.7976931348623157e+108，最大值为1.7976931348623157e+108。 | | suppress_duration | Integer | **参数解释**： 告警抑制时间，单位为秒，对应页面上创建告警规则时告警策略最后一个字段，该字段主要为解决告警频繁的问题。 **取值范围**： 枚举值，只能为0、300、600、900、1800、3600、10800、21600、43200、86400。 - 0：对于指标类告警，0代表告警一次。对于事件类告警，在立即触发场景中，0代表不抑制；在累计触发场景，0代表只告警一次。 - 300代表满足告警触发条件后每5分钟告警一次。 - 600代表满足告警触发条件后每10分钟告警一次。 - 900代表满足告警触发条件后每15分钟告警一次。 - 1800代表满足告警触发条件后每30分钟告警一次。 - 3600代表满足告警触发条件后每60分钟告警一次。 - 10800代表满足告警触发条件后每3小时告警一次。 - 21600代表满足告警触发条件后每6小时告警一次。 - 43200代表满足告警触发条件后每12小时告警一次。 - 86400代表满足告警触发条件后每一天告警一次。 | 表9AlarmActionsResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | \[数组元素\] | Array of [NotificationResp] objects | **参数解释**： 告警触发时，通知组/主题订阅的信息。 | 表10NotificationResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释**： 告警通知类型。 **取值范围**： - notification：通知组或主题订阅。 - autoscaling：AS通知，仅在AS使用。 | | notificationList | Array of strings | **参数解释**： 告警状态发生变化时，被通知对象的列表。 | 表11DataPointForAlarmHistoryResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | time | Long | **参数解释** 计算出该条告警历史的资源监控数据上报时间，UNIX时间戳，单位毫秒，如：1603131028000。 **取值范围**： 不涉及 | | value | Double | **参数解释** 计算出该条告警历史的资源监控数据在该时间点的监控数值，如：7.019。 **取值范围**： 具体阈值取值请参见附录中各服务监控指标中取值范围，如"[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)"中ECS的CPU使用率cpu_util取值范围可配置80。最小值为0，最大值为1.7976931348623157e+108。 | 表12AdditionalInfoResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | resource_id | String | **参数解释** 该条告警历史对应的资源ID；如：22d98f6c-16d2-4c2d-b424-50e79d82838f。 **取值范围**： 字符串长度最大为128。 | | resource_name | String | **参数解释** 该条告警历史对应的资源名称；如：ECS-Test01。 **取值范围**： 字符串长度最大为128。 | | event_id | String | **参数解释** 该条告警历史对应的事件监控ID，资源所产生的事件；如：ev16031292300990kKN8p17J。 **取值范围**： 字符串长度为24。 | 表13MetaDataForAlarmHistoryResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | **参数解释** 查询告警历史返回的总条数。 **取值范围**： 不涉及。 | **状态码：400** 表14响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 请求错误。 | **状态码：401** 表15响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 未提供认证信息，或认证信息错误。 | **状态码：403** 表16响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 请求页面被禁止访问。 | **状态码：408** 表17响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 请求超出了服务器的等待时间。 | **状态码：429** 表18响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 请求过多。 | **状态码：500** 表19响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 请求未完成，服务异常。 | **状态码：503** 表20响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 系统暂时不可用，请求受限。 | #### 请求示例 ``` GET /V1.0/{project_id}/alarm-histories?limit=10&start=0&from=1602494921346&to=1603099721346&alarm_name=alarm-test01 ``` #### 响应示例 **状态码：200** OK ``` { "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" : "ALL_INSTANCE", "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" : "22d98f6c-16d2-4c2d-b424-50e79d82838f", "resource_name" : "ECS-Test01", "event_id" : "ev16031292300990kKN8p17J" } } ], "meta_data" : { "total" : 1 } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | | 401 | Unauthorized | | 403 | Forbidden | | 408 | Request Timeout | | 429 | Too Many Requests | | 500 | Internal Server Error | | 503 | Service Unavailable | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-ces/ErrorCode.html)。