# 查询告警记录列表 - ListAlarmHistories #### 功能介绍 查询告警记录列表 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CES/doc?api=ListAlarmHistories&version=v2)中调试该接口，支持自动认证鉴权。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 /v2/{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参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | alarm_id | 否 | Array of strings | **参数解释**： 告警ID列表。告警ID：以al开头，后跟22位由字母或数字组成的字符串。 **约束限制**： 列表最大长度为50。 | | record_id | 否 | String | **参数解释**： 告警流水号。优化告警流水号生成规则，由之前的 ah1655717086704DEnBrJ999 更改为 ah251222T092004SAD2yARym **约束限制**： 不涉及。 **取值范围**： 以ah开头，后跟22位由字母或数字组成的字符串，字符串长度为24。 **默认取值**： 不涉及。 | | name | 否 | String | **参数解释**： 告警规则名称。 **约束限制**： 不涉及。 **取值范围**： 最大128字符长度。 **默认取值**： 不涉及。 | | status | 否 | Array of strings | **参数解释**： 告警规则状态列表。 **取值范围**： 告警规则状态：枚举值。 - ok：已解决 - alarm：告警中 - invalid：已失效 - insufficient_data: 数据不足 - ok_manual: 已解决（手动） **约束限制**： 包含的告警规则状态对象数量为\[0,3\] | | level | 否 | Integer | **参数解释**： 告警级别。 **约束限制**： 不涉及。 **取值范围**： 枚举值。 - 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个字符之间。 **默认取值**： 不涉及。 | | resource_id | 否 | String | **参数解释**： 告警资源ID。 **约束限制**： 不涉及。 **取值范围**： 多维度情况按字母升序排列并使用逗号分隔。长度为\[0,2048\]个字符。 **默认取值**： 不涉及。 | | from | 否 | String | **参数解释**： 查询告警记录的起始更新时间，例如：2022-02-10T10:05:46+08:00。 **约束限制**： 不涉及。 **取值范围**： 长度为\[0,64\]个字符。 **默认取值**： 不涉及。 | | to | 否 | String | **参数解释**： 查询告警记录的截止更新时间，例如：2022-02-10T10:05:47+08:00。 **约束限制**： 不涉及。 **取值范围**： 长度为\[0,64\]个字符。 **默认取值**： 不涉及。 | | alarm_type | 否 | String | **参数解释**： 告警类型。 **约束限制**： 不涉及。 **取值范围**： 枚举值 - event: 查询事件类型告警 - metric: 查询指标类型告警。 **默认取值**： 不涉及。 | | create_time_from | 否 | String | **参数解释**： 查询告警记录的起始创建时间，例如：2022-02-10T10:05:46+08:00。 **约束限制**： 不涉及。 **取值范围**： 长度为\[0,64\]个字符。 **默认取值**： 不涉及。 | | create_time_to | 否 | String | **参数解释**： 查询告警记录的截止创建时间，例如：2022-02-10T10:05:47+08:00。 **约束限制**： 不涉及。 **取值范围**： 长度为\[0,64\]个字符。 **默认取值**： 不涉及。 | | offset | 否 | Integer | **参数解释**： 分页偏移量。 **约束限制**： 不涉及。 **取值范围**： 整数，最小值为0，最大值为1000000000 **默认取值**： 0 | | limit | 否 | Integer | **参数解释**： 分页偏移量。 **约束限制**： 不涉及。 **取值范围**： 整数，最小值为1，最大值为100 **默认取值**： 100 | | order_by | 否 | String | **参数解释**： 按关键字排序。 **约束限制**： 不涉及。 **取值范围**： 枚举值。 - first_alarm_time: 告警产生时间 - update_time: 更新时间 - alarm_level: 告警级别 - record_id: 表记录主键 **默认取值**： update_time | | mask_status | 否 | String | **参数解释**： 告警规则屏蔽状态。 **约束限制**： 不涉及。 **取值范围**： - UN_MASKED：活跃告警 - MASKED：屏蔽告警 **默认取值**： 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 否 | String | **参数解释**: 发送的实体的MIME类型。 **约束限制**: 不涉及。 **取值范围**: 最小字符数量为1，最大为64。 **默认取值**: 默认使用application/json; charset=UTF-8。 | | X-Auth-Token | 否 | String | **参数解释**: 用户Token。Token认证，具体操作请参考[认证鉴权](https://support.huaweicloud.com/api-ces/ces_03_0011.html)。 **约束限制**: 不涉及。 **取值范围**: 最小字符数量为1，最大为16384。 **默认取值**: 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | alarm_histories | Array of [AlarmHistoryItemV2] objects | **参数解释**： 告警记录列表。 | | count | Integer | **参数解释**： 告警记录总数。 **取值范围**： \[0,2147483647\] | 表5AlarmHistoryItemV2 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | record_id | String | **参数解释**： 告警流水号。优化告警流水号生成规则，由 ah1655717086704DEnBrJ999 更改为 ah251222T092004SAD2yARym **取值范围**： 以ah开头，后跟22位由字母或数字组成的字符串，字符串长度为24。 | | alarm_id | String | **参数解释**： 告警规则ID。 **取值范围**： 以al开头，后跟22位的字母或数字。 | | name | String | **参数解释**： 告警名称。 **取值范围**： 只能包含0-9/a-z/A-Z/_/-或汉字，长度为\[1,128\]个字符。 | | status | String | **参数解释**： 告警规则状态 **取值范围**： 枚举值。 - ok：正常 - alarm：告警 - invalid：已失效 - insufficient_data: 数据不足 - ok_manual: 手动恢复 | | level | Integer | **参数解释**： 告警记录的告警级别。 **取值范围**： 值为1,2,3,4 - 1：紧急 - 2：重要 - 3：次要 - 4：提示 | | type | String | **参数解释**： 告警规则类型。 **取值范围**： 枚举值 - ALL_INSTANCE：全部资源指标告警 - RESOURCE_GROUP：资源分组指标告警 - MULTI_INSTANCE：指定资源指标告警 - EVENT.SYS：系统事件告警 - EVENT.CUSTOM：自定义事件告警 - DNSHealthCheck：健康检查告警 | | action_enabled | Boolean | **参数解释**： 是否发送通知 **取值范围**： - true：发送通知 - false：不发送通知 | | begin_time | String | **参数解释**： 产生时间,UTC时间 **取值范围**： 不涉及。 | | end_time | String | **参数解释**： 结束时间，UTC时间 **取值范围**： 不涉及。 | | first_alarm_time | String | **参数解释**： 第一次告警时间，UTC时间 **取值范围**： 不涉及。 | | last_alarm_time | String | **参数解释**： 最后一次告警时间，UTC时间。 **取值范围**： 不涉及。 | | alarm_recovery_time | String | **参数解释**： 告警恢复时间，UTC时间。 **取值范围**： 不涉及。 | | metric | [metric] object | **参数解释**: 指标信息。 | | condition | [condition] object | **参数解释**： 告警触发条件。 | | additional_info | [AdditionalInfo] object | **参数解释**： 告警记录额外字段，仅针对事件监控告警场景所产生的告警记录信息。 | | alarm_actions | Array of [alarm_actions] objects | **参数解释**： 告警触发时，通知组/主题订阅的信息。结构如下： { "type": "notification", "notification_list": \["urn:smn:southchina:68438a86d98e427e907e0097b7e35d47:sd"\] } | | ok_actions | Array of [ok_actions] objects | **参数解释**： 告警恢复时，通知组/主题订阅的信息。结构如下： { "type": "notification", "notification_list": \["urn:smn:southchina:68438a86d98e427e907e0097b7e35d47:sd"\] } | | data_points | Array of [DataPointInfo] objects | **参数解释**： 计算出该条告警记录的资源监控数据上报时间和监控数值。 | | mask_status | String | **参数解释**： 告警屏蔽状态。 **取值范围**： - MASKED：已屏蔽 - UN_MASKED：未屏蔽 | 表6metric | 参数 | 参数类型 | 描述 | |:---|:---|:---| | namespace | String | **参数解释**： 查询服务的命名空间，各服务命名空间请参阅[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)。 **取值范围**： 格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。字符串的长度在 0 到 32个字符之间。 | | metric_name | String | **参数解释**： 资源的监控指标名称，各服务资源的指标名称，请参阅具体云服务的文档。您可以直接从[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)页面导航至相应文档。 **取值范围**： 必须以字母开头，只能包含0-9/a-z/A-Z/_/-。字符长度最短为1，最大为96。如：弹性云服务器中的监控指标cpu_util，表示弹性服务器的CPU使用率；文档数据库中的指标mongo001_command_ps，表示command执行频率。 | | dimensions | Array of [dimensions] objects | **参数解释**： 资源列表。 **取值范围**： 不涉及。 | 表7dimensions | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**： 资源维度名称，如：弹性云服务器，则维度为instance_id。各服务资源的维度名称，请参阅具体云服务的文档。您可以直接从[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)页面导航至相应文档。 **取值范围**： 以字母开头，只能包含字母、数字、"_"、"-"。长度为\[1,32\]个字符。 | | value | String | **参数解释**： 资源维度值，为资源的实例ID，如：4270ff17-aba3-4138-89fa-820594c39755。 **取值范围**： 字符串长度在 1 到 256 之间。 | 表8condition | 参数 | 参数类型 | 描述 | |:---|:---|:---| | period | Integer | **参数解释**： 指标周期，单位是秒。如想了解各个云服务的指标原始周期可以参考[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)。 **取值范围**： 0是默认值，例如事件类告警该字段就用0即可； 1代表指标的原始周期，比如RDS监控指标原始周期是60s，表示该RDS指标按60s周期为一个数据点参与告警计算； 300代表指标按5分钟聚合周期为一个数据点参与告警计算； 1200代表指标按20分钟聚合周期为一个数据点参与告警计算； 3600代表指标按60分钟聚合周期为一个数据点参与告警计算； 14400代表指标按4小时聚合周期为一个数据点参与告警计算； 86400代表指标按1天聚合周期为一个数据点参与告警计算。 | | filter | String | **参数解释**： 聚合方式。 **取值范围**： - average：平均值 - variance：方差 - min：最小值 - max：最大值 - sum：求和 | | comparison_operator | String | **参数解释**： 阈值符号。 **取值范围**： 枚举值。支持的值为(\>\|\<\|\>=\|\<=\|=\|!=\|cycle_decrease\|cycle_increase\|cycle_wave);cycle_decrease为环比下降,cycle_increase为环比上升,cycle_wave为环比波动。 | | value | Double | **参数解释**： 告警阈值。 **取值范围**： 具体阈值取值请参见附录中各服务监控指标中取值范围，如[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)中ECS的CPU使用率cpu_util取值范围可配置80。最小值为-1.7976931348623157e+108，最大值为1.7976931348623157e+108。 | | unit | String | **参数解释**： 数据的单位。 **取值范围**： 字符串长度最大为 32。 | | count | Integer | **参数解释**： 告警连续触发次数。 **取值范围**： \[1,180\] | | 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代表满足告警触发条件后每一天告警一次。 | 表9AdditionalInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | resource_id | String | **参数解释**： 该条告警记录对应的资源ID；如：22d98f6c-16d2-4c2d-b424-50e79d82838f。 **取值范围**： 长度为\[0,128\]个字符。 | | resource_name | String | **参数解释**： 该条告警记录对应的资源名称；如：ECS-Test01。 **取值范围**： 长度为\[0,128\]个字符。 | | event_id | String | **参数解释**： 该条告警记录对应的事件监控ID，资源所产生的事件；如：ev16031292300990kKN8p17J。 **取值范围**： 字符串长度为24。 | 表10alarm_actions | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释**： 通知类型。 **取值范围**： 枚举值。 - notification：通知组或主题订阅。 - contact：云账号联系人。 - contactGroup：（已废弃）通知组。 - autoscaling：AS通知，只在AS中使用。 - groupwatch：已废弃，不推荐使用。 - ecsRecovery：已废弃，不推荐使用。 - iecAction：已废弃，不推荐使用。 | | notification_list | Array of strings | **参数解释**： 告警状态发生变化时，被通知对象的列表。topicUrn可从SMN获取，具体操作请参考查询Topic列表。 | 表11ok_actions | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释**： 通知类型。 **取值范围**： 枚举值。 - notification：通知组或主题订阅。 - contact：云账号联系人。 - contactGroup：（已废弃）通知组。 - autoscaling：AS通知，只在AS中使用。 - groupwatch：已废弃，不推荐使用。 - ecsRecovery：已废弃，不推荐使用。 - iecAction：已废弃，不推荐使用。 | | notification_list | Array of strings | **参数解释**： 告警状态发生变化时，被通知对象的列表。topicUrn可从SMN获取，具体操作请参考查询Topic列表。 | 表12DataPointInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | time | String | **参数解释**： 计算出该条告警记录的资源监控数据上报的UTC时间。 **取值范围**： 字符串长度在 1 到 64 之间。 | | value | Double | **参数解释**： 计算出该条告警记录的资源监控数据在该时间点的监控数值，如：7.019 **取值范围**： 整数，最小值为-1.7976931348623157e+108，最大值为1.7976931348623157e+108 | **状态码：400** 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 用于标识请求异常的具体原因。 **取值范围**： 字符串长度为0到256个字符。 | | error_msg | String | **参数解释**： 用于描述请求异常的具体信息。 **取值范围**： 字符串长度为0到256个字符。 | | request_id | String | **参数解释**： 用于唯一标识一次请求，便于问题追踪。 **取值范围**： 字符串长度为0到256个字符。 | **状态码：500** 表14响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 用于标识请求异常的具体原因。 **取值范围**： 字符串长度为0到256个字符。 | | error_msg | String | **参数解释**： 用于描述请求异常的具体信息。 **取值范围**： 字符串长度为0到256个字符。 | | request_id | String | **参数解释**： 用于唯一标识一次请求，便于问题追踪。 **取值范围**： 字符串长度为0到256个字符。 | #### 请求示例 查询告警名称为alarm-test01，且时间为2022-02-10T10:05:46+08:00到2022-02-10T12:05:46+08:00的告警记录列表。 ``` /v2/{project_id}/alarm-histories?limit=10&offset=0&from=2022-02-10T10:05:46+08:00&to=2022-02-10T12:05:46+08:00&alarm_name=alarm-test01 ``` #### 响应示例 **状态码：200** 查询成功 ``` { "alarm_histories" : [ { "alarm_id" : "al1604473987569z6n6nkpm1", "record_id" : "ah251222T092004SAD2yARym", "name" : "TC_CES_FunctionBaseline_Alarm_008", "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, "unit" : "", "count" : 3, "suppress_duration" : 3600 }, "level" : 2, "type" : "ALL_INSTANCE", "begin_time" : "2024-02-11T05:48:08+08:00", "end_time" : "2024-02-11T08:48:08+08:00", "first_alarm_time" : "2024-02-11T06:48:08+08:00", "last_alarm_time" : "2024-02-11T08:48:08+08:00", "alarm_recovery_time" : "2024-02-11T08:48:08+08:00", "action_enabled" : false, "alarm_actions" : [ ], "ok_actions" : [ ], "status" : "alarm", "data_points" : [ { "time" : "2022-06-22T16:38:02+08:00", "value" : 873.1507798960139 }, { "time" : "2022-06-22T16:28:02+08:00", "value" : 883.1507798960139 }, { "time" : "2022-06-22T16:18:02+08:00", "value" : 873.4 } ], "additional_info" : { "resource_id" : "22d98f6c-16d2-4c2d-b424-50e79d82838f", "resource_name" : "ECS-Test01", "event_id" : "ev16031292300990kKN8p17J" }, "mask_status" : "UN_MASKED" } ], "count" : 103 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功 | | 400 | 参数校验失败 | | 500 | 系统内部错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-ces/ErrorCode.html)。