# 查询告警列表 - QueryingAlarms #### 功能介绍 查询告警列表。 - 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。 - 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=ShowAlarmHistoryRecord)中调试该接口。 #### URI GET /v3/{project_id}/alarm-history-record 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | | start_time | 是 | String | **参数解释：** 查询开始时间。 **约束限制：** 最多可以获取最近7天的数据。 **取值范围：** 格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **默认取值** **：** 不涉及。 | | level | 否 | Integer | **参数解释** **：** 实例告警等级。 **约束限制：** 不涉及。 **取值范围** **：** - 1：紧急。 - 2：重要。 - 3：次要。 - 4：提示。 **默认取值** **：** 1 | | limit | 是 | Integer | **参数解释：** 查询记录数。例如该参数设定为10，则查询结果最多只显示10条记录。 **约束限制：** 不涉及。 **取值范围：** \[1, 50\] **默认取值**： 50 | | offset | 是 | Integer | **参数解释：** 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。例如：该参数指定为1，limit指定为10，则只展示第2-11条数据。 **约束限制：** 不涉及。 **取值范围：** \[0, 2147483647\] **默认取值**： 默认为0（偏移0条数据，表示从第一条数据开始查询）。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | X-Language | 否 | String | **参数解释：** 指定接口返回信息的语言类型。 **约束限制：** 不涉及。 **取值范围：** - **zh-cn**：中文 - **en-us**：英文 **默认取值** **：** **en-us** | #### 响应参数 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_count | Integer | **参数解释：** 总数量。 **取值范围：** 不涉及。 | | history_records | Array of [表4] objects | **参数解释：** 告警记录列表。 | 表4AlarmHistoryRecordInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | alarm_id | String | **参数解释：** 告警规则ID。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 告警规则名称。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 告警记录的状态。 **取值范围：** - ok：正常。 - alarm：告警。 - invalid：已失效。 | | alarm_type | String | **参数解释：** 告警规则类型。 **取值范围：** - EVENT.SYS：系统事件告警。 - EVENT.CUSTOM：自定义事件告警。 - DNSHealthCheck：DNS健康检查告警。 - RESOURCE_GROUP：资源分组告警。 - MULTI_INSTANCE：指定资源告警。 | | level | Integer | **参数解释：** 告警历史的告警级别。 **取值范围：** - 1：紧急。 - 2：重要。 - 3：次要。 - 4：提示。 | | instance_id | String | **参数解释：** 实例ID。 **取值范围：** 只能由英文字母、数字组成，且长度为36个字符。 | | instance_name | String | **参数解释：** 实例名称。 **取值范围：** 不涉及。 | | begin_time | Long | **参数解释：** 告警开始时间。 **取值范围：** UNIX时间戳，单位毫秒，例如：1603131199000。 | | update_time | Long | **参数解释：** 告警状态变更的时间。 **取值范围：** UNIX时间戳，单位毫秒，例如：1603131199000。 | #### 请求示例 查询告警列表。 ``` GET https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/9a29cc53af2f499cb48a6d81839264cb/alarm-history-record?start_time=2022-06-22T16:38:02%2B0800&offset=0&limit=10 ``` #### 响应示例 ``` { "total_count": 1, "history_records": [ { "alarm_id": "al1603131199286dzxpqK3Ez", "name": "磁盘资源不足", "status": "alarm", "alarm_type": "EVENT.SYS", "level": 1, "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin14", "instance_name": "gauss_test", "begin_time": 1603131199000, "update_time": 1603131199000 } ] } ``` #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。