查询告警信息列表 - ShowAlarmInfoList
功能介绍
分页查询告警信息列表,支持多条件过滤
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v2/{project_id}/sec-ops/alarms
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 项目唯一标识符 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
alarm_level | 否 | String | 告警级别 |
alarm_name | 否 | String | 告警名称 |
alarm_status | 否 | String | 告警处理状态 |
end_time | 否 | Long | 查询结束时间(时间戳) |
limit | 否 | Integer | 每页返回记录数 |
offset | 否 | Integer | 分页查询偏移量 |
responsible_person | 否 | String | 告警负责人 |
source_name | 否 | String | 告警源名称 |
source_type | 否 | String | 告警源类型 |
start_time | 否 | Long | 查询开始时间(时间戳) |
verification_status | 否 | String | 验证状态 |
请求参数
无
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
alarm_info_list | Array of AlarmInfoNew objects | 告警信息列表 |
total | Integer | 告警总数量 |
参数 | 参数类型 | 描述 |
|---|---|---|
affected_asset | Array of strings | 受影响资产 |
alarm_level | String | 告警等级 |
alarm_name | String | 告警名称 |
alarm_status | String | 告警状态 |
alarm_type | String | 告警类型 |
close_reason | String | 关闭告警原因 |
create_time | Long | 告警创建时间 |
description | String | 告警描述 |
disposal_suggestion | String | 处置建议 |
domain_id | String | 账户ID |
id | Long | 告警ID |
occur_time | Long | 告警发生时间 |
project_id | String | 租户ID |
responsible_person | UserInfo object | 责任人 |
source_instance | InstanceInfo object | 告警来源实例 |
source_module | String | 告警来源功能模块 |
source_sub_type | String | 告警来源子类型 |
source_type | String | 告警来源类型 |
verification_status | String | 验证状态 |
状态码:401
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误信息 |
状态码:403
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误信息 |
状态码:404
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误信息 |
请求示例
无
响应示例
无
状态码
状态码 | 描述 |
|---|---|
200 | OK |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
错误码
请参见错误码。

