# 查询审计告警信息\[待下线\] - ListAuditAlarmLog #### 功能介绍 查询审计告警信息 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DBSS/doc?api=ListAuditAlarmLog)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dbss/dbss_01_0428.html)。 #### URI POST /v1/{project_id}/{instance_id}/audit/alarm-log 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID。可通过IAM服务\[查询指定IAM用户的项目列表\]接口获取。 **约束限制**： 不涉及 **取值范围**： 以IAM服务接口返回值为准，字符长度32-64。 **默认取值**： 不涉及 | | instance_id | 是 | String | **参数解释**： 实例ID。可通过查询实例列表接口ID字段获取 **约束限制**： 不涉及 **取值范围**： 以查询实例列表接口值为准，字符长度32-64。 **默认取值**： 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制**： 不涉及 **取值范围**： IAM服务查询用户Token接口为准 **默认取值**： 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | time | 是 | [time] object | 时间 | | risk | 否 | Array of strings | 风险级别 - LOW：低 - MEDIUM：中 - HIGH：高 | | type | 否 | String | 告警类型 - RISK_RULE：风险规则 - RISK_CPU：CPU超限 - RISK_MEMORY：内存超限 - RISK_DISK：磁盘超限 - RISK_DISK_CAPACITY：磁盘容量不足六个月 - RISK_BACKUP：备份失败 - AUDIT_QPS_OVERFLOW：流量超限入库延迟告警 - RISK_AGENT：Agent异常 - AUDIT_BACKUP_FAILED：实例备份失败(运维侧) | | status | 否 | String | 告警确认状态 - DONE：已确认 - UNDO：未确认 | | page | 是 | Integer | 页码 | | size | 是 | Integer | 每页条数 | 表4time | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | time_range | 否 | String | 时间范围。和start_time，end_time不能同时使用，同时传该参数优先级更高。枚举值 - HALF_HOUR：半小时 - HOUR：1小时 - THREE_HOUR：3小时 - TWELVE_HOUR：12小时 - DAY：1天 - WEEK：1周 - MONTH：1个月; | | start_time | 否 | String | 开始时间，必须和end_time成对出现。格式必须为yyyy-MM-dd HH:mm:ss。UTC时间 | | end_time | 否 | String | 结束时间，必须和start_time成对出现。格式必须为yyyy-MM-dd HH:mm:ss。UTC时间 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_num | Integer | 总条数 | | alarm_log | Array of [alarm_log] objects | 告警列表 | 表6alarm_log | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 告警ID | | alarmLife | String | 告警状态 - ON：持续中 - OFF：已关闭 | | sendEmail | Boolean | 是否发送邮件 | | alarm_time | String | 告警发生时间 | | alarm_type | String | 告警类型 - RISK_RULE：风险规则 - RISK_CPU：CPU超限 - RISK_MEMORY：内存超限 - RISK_DISK：磁盘超限 - RISK_DISK_CAPACITY：磁盘容量不足六个月 - RISK_BACKUP：备份失败 - AUDIT_QPS_OVERFLOW：流量超限入库延迟告警 - RISK_AGENT：Agent异常 - AUDIT_BACKUP_FAILED：实例备份失败(运维侧) | | alarm_fix_time | String | 告警恢复时间 | | alarm_status | String | 告警确认状态 - DONE：已确认 - UNDO：未确认 | | alarm_risk | String | 告警风险等级 - LOW：低 - MEDIUM：中 - HIGH：高 | | alarm_description | String | 告警描述信息 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | details | Array of [DbssErrorDetail] objects | PDP5鉴权异常信息 | | encoded_authorization_message | String | PDP5鉴权异常信息 | | error_code | String | 错误码 | | error_msg | String | 错误信息 | 表8DbssErrorDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | PDP5错误信息 | **状态码：403** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | details | Array of [DbssErrorDetail] objects | PDP5鉴权异常信息 | | encoded_authorization_message | String | PDP5鉴权异常信息 | | error_code | String | 错误码 | | error_msg | String | 错误信息 | 表10DbssErrorDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | PDP5错误信息 | **状态码：500** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | details | Array of [DbssErrorDetail] objects | PDP5鉴权异常信息 | | encoded_authorization_message | String | PDP5鉴权异常信息 | | error_code | String | 错误码 | | error_msg | String | 错误信息 | 表12DbssErrorDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | PDP5错误信息 | #### 请求示例 ``` /v1/{project_id}/{instance_id}/audit/alarm-log { "time" : { "time_range" : "DAY", "start_time" : null, "end_time" : null }, "risk" : null, "type" : null, "status" : null, "page" : 1, "size" : 100 } ``` #### 响应示例 **状态码：200** 成功 ``` { "total_num" : 3, "alarm_log" : [ { "id" : "99AJFI8BZEbGVdGbOczC", "alarmLife" : "ON", "sendEmail" : true, "alarm_time" : "2024-04-25 06:55:00", "alarm_type" : "RISK_DISK", "alarm_fix_time" : null, "alarm_status" : "UNDO", "alarm_description" : "DISK USAGE 5%", "alarm_risk" : "HIGH" }, { "id" : "9tAJFI8BZEbGVdGbOcy4", "alarmLife" : "ON", "sendEmail" : true, "alarm_time" : "2024-04-25 06:55:00", "alarm_type" : "RISK_MEMORY", "alarm_fix_time" : null, "alarm_status" : "UNDO", "alarm_description" : "MEMORY USAGE 53.54%", "alarm_risk" : "HIGH" }, { "id" : "9dAJFI8BZEbGVdGbOcyq", "alarmLife" : "ON", "sendEmail" : true, "alarm_time" : "2024-04-25 06:55:00", "alarm_type" : "RISK_CPU", "alarm_fix_time" : null, "alarm_status" : "UNDO", "alarm_description" : "CPU USAGE 1.0%", "alarm_risk" : "HIGH" } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功 | | 400 | 请求参数错误 | | 403 | 认证失败 | | 500 | 服务器内部错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dbss/ErrorCode.html)。