告警管理-查询告警信息列表 - ShowAlarmInfoList
功能介绍
功能介绍:查询告警信息列表。按 project 查询未删除的告警,支持按告警名称、告警级别、来源类型、来源名称、告警状态、验证状态、责任人及时间范围过滤,结果按告警时间倒序分页返回。
查询参数:alarm_name、alarm_level、source_type、source_name、alarm_status、verification_status、responsible_person、start_time、end_time、limit、offset(均为可选;start_time 与 end_time 需同时传入且 start_time<=end_time 时才生效)。
响应:请求成功返回HTTP 200及告警列表。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v2/{project_id}/security-op/alarm/info
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,长度为32个字符,满足正则匹配"^[a-z0-9]{32}$" 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| alarm_name | 否 | String | 参数解释: 告警名称,用于按名称模糊匹配告警 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| alarm_level | 否 | String | 参数解释: 告警级别,用于按级别精确筛选 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| source_type | 否 | String | 参数解释: 来源类型,用于按来源精确筛选 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| source_name | 否 | String | 参数解释: 来源名称,用于按实例名称模糊匹配 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| alarm_status | 否 | String | 参数解释: 告警状态,用于按状态精确筛选 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| verification_status | 否 | String | 参数解释: 验证状态,用于按验证状态精确筛选 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| responsible_person | 否 | String | 参数解释: 责任人,用于按责任人模糊匹配 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| start_time | 否 | Long | 参数解释: 开始时间,毫秒级Unix时间戳 约束限制: 与 end_time 需同时传入,且 start_time 小于等于 end_time 时才生效 取值范围: 毫秒级Unix时间戳 默认取值: 不涉及 |
| end_time | 否 | Long | 参数解释: 结束时间,毫秒级Unix时间戳 约束限制: 与 start_time 需同时传入,且 start_time 小于等于 end_time 时才生效 取值范围: 毫秒级Unix时间戳 默认取值: 不涉及 |
| limit | 否 | Integer | 参数解释: 分页查询每页条数 约束限制: 不涉及 取值范围: 不涉及 默认取值: 1000 |
| offset | 否 | Integer | 参数解释: 分页查询偏移量(页码) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 0 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 参数解释: 总记录数 取值范围: 不涉及 |
| alarm_info_list | Array of AlarmInfoNew objects | 参数解释: 告警信息列表 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | Long | 参数解释: 告警ID,唯一标识 取值范围: 不涉及 |
| project_id | String | 参数解释: 项目ID 取值范围: 不涉及 |
| domain_id | String | 参数解释: 账号ID 取值范围: 不涉及 |
| alarm_name | String | 参数解释: 告警名称 取值范围: 不涉及 |
| alarm_type | String | 参数解释: 告警类型,格式为 sourceType/sourceSubType,如 DATABASE/SQL_INJECTION 取值范围: 不涉及 |
| alarm_level | String | 参数解释: 告警级别 取值范围: |
| alarm_status | String | 参数解释: 告警状态 取值范围: |
| close_reason | String | 参数解释: 关闭原因 取值范围: 不涉及 |
| verification_status | String | 参数解释: 验证状态 取值范围: |
| source_module | String | 参数解释: 来源功能模块 取值范围: |
| source_type | String | 参数解释: 来源类型 取值范围: |
| source_client_ip | String | 参数解释: 来源客户端IP地址 取值范围: 不涉及 |
| source_sub_type | String | 参数解释: 来源子类型 取值范围: |
| source_instance | source_instance object | 参数解释: 来源实例信息 取值范围: 不涉及 |
| responsible_person | responsible_person object | 参数解释: 责任人信息 取值范围: 不涉及 |
| affected_asset | Array of strings | 参数解释: 受影响资产列表,数组元素为String类型 取值范围: 不涉及 |
| create_time | Long | 参数解释: 创建时间,13位毫秒级Unix时间戳 取值范围: 不涉及 |
| occur_time | Long | 参数解释: 发生时间,13位毫秒级Unix时间戳 取值范围: 不涉及 |
| disposal_suggestion | String | 参数解释: 处置建议 取值范围: 不涉及 |
| description | String | 参数解释: 告警描述 取值范围: 不涉及 |
请求示例
查询告警信息列表请求示例
/v2/2b31ed5200000ebedb6e570000000000/security-op/alarm/info?alarm_name=SQL注入&alarm_level=HIGH_RISK&source_type=DBSS&alarm_status=OPEN&verification_status=NEED&start_time=1700000000000&end_time=1700086400000&limit=1000&offset=0
响应示例
状态码:200
{
"total" : 2,
"alarm_info_list" : [ {
"id" : 1001,
"project_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
"domain_id" : "a99d2c9b-8f4e-4d3a-8c2b-1e5f7a9b3c4d",
"alarm_name" : "检测到SQL注入攻击行为",
"alarm_type" : "DATABASE/SQL_INJECTION",
"alarm_level" : "MIDDLE_RISK",
"alarm_status" : "OPEN",
"close_reason" : null,
"verification_status" : "CONFIRM",
"source_module" : "DBSS",
"source_type" : "DATABASE",
"source_client_ip" : "192.168.0.1",
"source_sub_type" : "SQL_INJECTION",
"source_instance" : {
"instance_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
"instance_name" : "dbss-instance-01"
},
"responsible_person" : {
"user_id" : "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
"user_name" : "zhangsan"
},
"affected_asset" : [ "asset-db-01", "asset-obs-01" ],
"create_time" : 1700000000000,
"occur_time" : 1700000000000,
"disposal_suggestion" : "建议立即吊销泄露凭据并轮换密钥",
"description" : "检测到针对数据库的SQL注入攻击行为,存在数据泄露风险"
}, {
"id" : 1002,
"project_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
"domain_id" : "a99d2c9b-8f4e-4d3a-8c2b-1e5f7a9b3c4d",
"alarm_name" : "检测到高危操作行为",
"alarm_type" : "DATABASE/RISK_OPERATION",
"alarm_level" : "HIGH_RISK",
"alarm_status" : "CLOSE",
"close_reason" : "误报,已确认无安全风险",
"verification_status" : "EXCLUDE",
"source_module" : "DBSS",
"source_type" : "DATABASE",
"source_client_ip" : "192.168.0.1",
"source_sub_type" : "RISK_OPERATION",
"source_instance" : {
"instance_id" : "0d2468ac-3a9e-4b2f-8c5d-1f7a2b3c4d5e",
"instance_name" : "dbss-instance-02"
},
"responsible_person" : {
"user_id" : "f7e6d5c4-b3a2-1908-7f6e-5d4c3b2a1908",
"user_name" : "lisi"
},
"affected_asset" : [ "asset-db-02" ],
"create_time" : 1700000000000,
"occur_time" : 1700000000000,
"disposal_suggestion" : "建议排查高危操作来源并加固权限",
"description" : "检测到针对数据库的高危操作行为,存在数据泄露风险"
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
错误码
请参见错误码。