# 获取告警信息 - ListDeviceAlarms #### 功能介绍 功能介绍：获取指定项目下第三方设备的告警信息列表（与告警信息接口同一数据源），支持按告警类型、模块、严重程度、状态、创建时间等条件过滤，返回告警总数及分页告警信息列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dsc/dsc_02_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dsc/dsc_02_0031.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v1/{project_id}/devices/alarms 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID。可参考获取项目ID获取。 **约束限制：** 满足正则匹配"\^\[a-z0-9\]{32}$" **取值范围：** 以IAM服务接口返回值为准，字符长度为32个字符。 **默认取值：** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释：** 每页数量限制 **约束限制：** 不涉及 **取值范围：** 1\~1000 **默认取值：** 100（不传时默认取100） | | offset | 否 | Integer | **参数解释：** 分页偏移 **约束限制：** 不涉及 **取值范围：** 0及以上 **默认取值：** 0（不传时默认取0） | | type | 否 | Array of integers | **参数解释：** 设备类型列表，数组中的每个元素为设备类型（Integer），用于按设备类型过滤查询 **约束限制：** 不涉及 **取值范围：** 0-应用数据审计 1-应用数据安全网关 2-数据库防火墙 3-数据库加密 4-静态脱敏实例 5-数据库动脱实例 **默认取值：** 不涉及 | | module | 否 | Array of strings | **参数解释：** 告警模块列表，数组中的每个元素为告警模块（String），用于按告警模块过滤查询 **约束限制：** 不涉及 **取值范围：** SYSTEM-系统告警 SERVICE-业务告警 **默认取值：** 不涉及 | | severity | 否 | Array of integers | **参数解释：** 告警严重程度列表，数组中的每个元素为告警严重程度（Integer），用于按告警严重程度过滤查询 **约束限制：** 不涉及 **取值范围：** 1-致命 2-严重 3-次要 4-警告 5-不确定 6-已清除 **默认取值：** 不涉及 | | create_time | 否 | String | **参数解释：** 创建时间筛选，用于按设备创建时间过滤 **约束限制：** 不涉及 **取值范围：** 0-今天 1-近1天 2-近3天 3-近7天 4-近30天 **默认取值：** 不涉及 | | status | 否 | Array of strings | **参数解释：** 告警状态列表，数组中的每个元素为告警状态（String），用于按告警状态过滤查询 **约束限制：** 不涉及 **取值范围：** UNPROCESSED-未处理 PROCESSED-已处理 IGNORED-已忽略 **默认取值：** 不涉及 | | keywords | 否 | String | **参数解释：** 关键字，用于按关键字进行模糊搜索，过滤出名称或描述等匹配的记录 **约束限制：** 最大长度255字符 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | alarm_infos | Array of [AlarmInfo] objects | **参数解释：** 告警信息列表 **取值范围：** 不涉及 | | total | Integer | **参数解释：** 总记录数 **取值范围：** 不涉及 | 表5AlarmInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Long | **参数解释：** 告警ID，标识一条告警记录，可通过查询告警信息列表接口获取 **取值范围：** 不涉及 | | name | String | **参数解释：** 告警名称 **取值范围：** 不涉及 | | type | Integer | **参数解释：** 告警类型 **取值范围：** 不涉及 | | module | String | **参数解释：** 告警模块 **取值范围：** - SYSTEM-系统告警 - SERVICE-业务告警 | | severity | Integer | **参数解释：** 告警严重程度 **取值范围：** 不涉及 | | create_time | Long | **参数解释：** 创建时间 **取值范围：** 不涉及 | | device_ip | String | **参数解释：** 设备IP地址 **取值范围：** 不涉及 | | status | String | **参数解释：** 告警状态 **取值范围：** - UNPROCESSED-未处理 - PROCESSED-已处理 - IGNORED-已忽略 | | count | Integer | **参数解释：** 告警信息数量 **取值范围：** 不涉及 | | description | String | **参数解释：** 资源描述信息 **取值范围：** 不涉及 | #### 请求示例 获取告警信息 ``` /v1/2b31ed520aabbccddeedb6e5712345678/devices/alarms ``` #### 响应示例 **状态码：200** ``` { "alarm_infos" : [ { "id" : 1001, "name" : "设备离线告警", "type" : 1, "module" : "SYSTEM", "severity" : 1, "create_time" : 1700000000000, "device_ip" : "192.168.0.2", "status" : "UNPROCESSED", "count" : 1, "description" : "设备dbss-02离线，请检查网络连接" }, { "id" : 1002, "name" : "设备CPU使用率过高", "type" : 2, "module" : "SERVICE", "severity" : 2, "create_time" : 1700100000000, "device_ip" : "192.168.0.1", "status" : "PROCESSED", "count" : 3, "description" : "设备firewall-01的CPU使用率超过90%" } ], "total" : 2 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dsc/ErrorCode.html)。