# 服务器告警列表 - ListAlarms #### 功能介绍 该 API 用于查询服务器告警列表 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-clouddc/clouddc_api_0003.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-clouddc/clouddc_api_0011.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | clouddc::listAlarm | List | - | - | - | ces:alarmHistory:list | #### URI GET /v1/{project_id}/physicalservers/alarms 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID **约束限制**： 不涉及 **取值范围**： 账号的项目ID **默认取值**： 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | alarm_record_id | 否 | String | **参数解释**： 告警记录ID, 在告警列表响应中查询，可以为空 **约束限制**： 不涉及 **取值范围**： 以ah开头，后跟22位由字母或数字组成的字符串。 **默认取值**： 不涉及 | | alarm_status | 否 | String | **参数解释**： 告警状态。 **约束限制**： 不涉及 **取值范围**： - ok：正常 - alram：告警 - invalid：已失效(告警规则中监控的资源或告警策略有调整，原有的告警记录状态失效) **默认取值**： 不涉及 | | alarm_type | 否 | String | **参数解释**： 告警类型 **约束限制**： 不涉及 **取值范围**： - event：事件 - metric：指标 **默认取值**： 不涉及 | | resource_id | 否 | String | **参数解释**： 告警资源ID,多值可以以逗号分割 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | alarm_level | 否 | Integer | **参数解释**： 告警级别，1为紧急，2为重要，3为次要，4为提示 **约束限制**： 不涉及 **取值范围**： - 1：紧急 - 2：重要 - 3：次要 - 4：提示 **默认取值**： 不涉及 | | from | 否 | Integer | **参数解释**： 产生告警开始时间，单位秒。 **约束限制**： from 必须小于 to。 **取值范围**： 时间戳格式 **默认取值**： 不涉及 | | to | 否 | Integer | **参数解释**： 产生告警结束时间，单位秒。 **约束限制**： from 必须小于 to。 **取值范围**： 时间戳格式 **默认取值**： 不涉及 | | offset | 否 | Integer | **参数解释**： 分页游标 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | limit | 否 | Integer | **参数解释**： 分页大小 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 调用接口的认证方式分为Token，如果您使用的Token方式，此参数为必填，请填写Token的值 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | alarms | Array of [AlarmHistory] objects | **参数解释**： 告警列表对象 **约束限制**： 不涉及 | | count | Integer | **参数解释**： 告警总数 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表5AlarmHistory | 参数 | 参数类型 | 描述 | |:---|:---|:---| | alarm_record_id | String | **参数解释**： 告警记录ID **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | alarm_id | String | **参数解释**： 告警ID **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | alarm_name | String | **参数解释**： 告警名称 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | alarm_status | String | **参数解释**： 告警状态。 **约束限制**： 不涉及 **取值范围**： - ok：正常 - alram：告警 - invalid：已失效(告警规则中监控的资源或告警策略有调整，原有的告警记录状态失效) **默认取值**： 不涉及 | | alarm_level | Integer | **参数解释**： 告警级别，1为紧急，2为重要，3为次要，4为提示 **约束限制**： 不涉及 **取值范围**： - 1：紧急 - 2：重要 - 3：次要 - 4：提示 **默认取值**： 不涉及 | | begin_time | Integer | **参数解释**： 告警开始时间 **约束限制**： 不涉及 **取值范围**： Unix时间戳 **默认取值**： 不涉及 | | end_time | Integer | **参数解释**： 告警结束时间 **约束限制**： 不涉及 **取值范围**： Unix时间戳 **默认取值**： 不涉及 | | last_alarm_time | Integer | **参数解释**： 最后一次告警时间 **约束限制**： 不涉及 **取值范围**： Unix时间戳 **默认取值**： 不涉及 | | metric | [Metric] object | - | 表6Metric | 参数 | 参数类型 | 描述 | |:---|:---|:---| | metric_name | String | **参数解释**： 资源的监控指标名称；如：弹性云服务器中的监控指标cpu_util，表示弹性服务器的CPU使用率；文档数据库中的指标mongo001_command_ps，表示command执行频率；各服务的指标名称可查看：[服务指标名称](https://support.huaweicloud.com/usermanual-ces/zh-cn_topic_0202622212.html)。 **约束限制**： 不涉及 **取值范围**： 必须以字母开头，只能包含0-9/a-z/A-Z/_，字符长度最短为1，最大为64 **默认取值**： 不涉及 | | dimensions | Array of [Dimension] objects | **参数解释**： 资源维度 **约束限制**： 不涉及 | 表7Dimension | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**： 资源维度，如：弹性云服务器，则维度为instance_id；目前最大支持4个维度，各服务资源的指标维度名称可查看：[服务指标名称](https://support.huaweicloud.com/usermanual-ces/zh-cn_topic_0202622212.html)。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | value | String | **参数解释**： 资源维度值，为资源的实例ID，如：4270ff17-aba3-4138-89fa-820594c39755。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | **状态码：400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码 | | error_msg | String | **参数解释**： 错误描述 | **状态码：401** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码 | | error_msg | String | **参数解释**： 错误描述 | **状态码：429** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | - | **状态码：500** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码 | | error_msg | String | **参数解释**： 错误描述 | #### 请求示例 服务器告警列表 ``` GET https://{endpoint}/v1/{project_id}/physicalservers/alarms ``` #### 响应示例 **状态码：200** ``` { "alarms" : [ { "alarm_record_id" : "ah175258182510684b1cb108", "alarm_id" : "al17525818209074GL0BZQMw", "alarm_name" : "alarm-0715", "alarm_status" : "alarm", "alarm_level" : 2, "begin_time" : 1752581825000, "end_time" : 1752725863000, "last_alarm_time" : 1752725863000, "metric" : { "metric_name" : "disk_health", "dimensions" : [ { "name" : "device", "value" : "Disk0" }, { "name" : "host", "value" : "019661e2-5390-7aa5-91e8-5fc6841f6ed9" } ] } } ], "count" : 347 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | - | | 400 | 请求参数错误，请求失败 | | 401 | 请求未鉴权 | | 429 | 请求过载 | | 500 | 服务端内部错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-clouddc/ErrorCode.html)。