文档首页/ 数据安全中心 DSC/ API参考/ API/ 告警管理/ 查看告警列表 - ListAlarmRecords
更新时间:2026-10-09 GMT+08:00
分享

查看告警列表 - ListAlarmRecords

功能介绍

功能介绍:查看告警列表

接口约束

  • 无特殊约束。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/alarms

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

不涉及

取值范围:

以IAM服务接口返回值为准,字符长度32-32,满足正则匹配"^[a-z0-9]{32}$"

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

source_type

否

String

参数解释:

来源类型。

约束限制:

不涉及

取值范围:

  • DBSS-数据库审计服务

  • CBH-云堡垒机

  • API-API网关

  • COMMON-通用

  • DATABASE-数据库

默认取值:

不涉及

type

否

String

参数解释:

类型。

约束限制:

不涉及

取值范围:

  • SERVICE-服务

  • SYSTEM-系统

默认取值:

不涉及

level

否

String

参数解释:

告警级别。

约束限制:

不涉及

取值范围:

  • NOTICE_RISK-提示

  • LOW_RISK-危险

  • MIDDLE_RISK-中危

  • HIGH_RISK-高危

  • FATAL_RISK-致命

默认取值:

不涉及

source_name

否

String

参数解释:

来源名称。

约束限制:

不涉及

取值范围:

字符长度1-256

默认取值:

不涉及

cycle

否

String

参数解释:

告警周期。

约束限制:

不涉及

取值范围:

  • ONE_DAY-当天

  • THREE_DAY-三天

  • SEVEN_DAY-七天

  • THIRTY_DAY-三十天

默认取值:

不涉及

offset

否

Integer

参数解释:

分页查询偏移量。

约束限制:

不涉及

取值范围:

0-2147483647

默认取值:

0

limit

否

Integer

参数解释:

分页查询每页条数。

约束限制:

不涉及

取值范围:

1-1000

默认取值:

1000

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

IAM服务查询用户Token接口为准

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total

Long

参数解释:

总记录数

取值范围:

不涉及

alarms

Array of AlarmInfo objects

参数解释:

告警列表

取值范围:

不涉及

表5 AlarmInfo

参数

参数类型

描述

id

Long

参数解释:

资源ID,唯一标识

取值范围:

不涉及

name

String

参数解释:

告警名称

取值范围:

不涉及

type

Integer

参数解释:

告警类型

取值范围:

  • GDE-数据库加密

  • GDE_DECRYPT-数据库加密(解密)

  • DOM-数据库运维

  • DBSS-数据库审计

  • DDM-数据库动脱

  • SDM-数据库静脱

module

DeviceAlarmModule object

参数解释:

来源功能模块

取值范围:

不涉及

severity

Integer

参数解释:

告警级别

取值范围:

不涉及

create_time

Long

参数解释:

创建时间

取值范围:

不涉及

device_ip

String

参数解释:

设备IP地址

取值范围:

不涉及

status

String

参数解释:

告警状态

取值范围:

  • UNPROCESSED: 未处理

  • PROCESSED: 已处理

  • IGNORED: 已忽略

count

Integer

参数解释:

告警发生次数

取值范围:

不涉及

description

String

参数解释:

资源描述信息

取值范围:

不涉及

表6 DeviceAlarmModule

参数

参数类型

描述

module

String

参数解释:

告警模块

取值范围:

不涉及

请求示例

无

响应示例

状态码:200

{
  "total" : 2,
  "alarms" : [ {
    "id" : 1001,
    "name" : "alarm-sql-injection-01",
    "type" : "DBSS",
    "module" : {
      "module" : "DBSS"
    },
    "severity" : 3,
    "create_time" : 1700000000000,
    "device_ip" : "192.168.0.1",
    "status" : "PROCESSED",
    "count" : 10,
    "description" : "检测到针对数据库的SQL注入攻击行为,存在数据泄露风险"
  }, {
    "id" : 1002,
    "name" : "alarm-sql-injection-01",
    "type" : "DBSS",
    "module" : {
      "module" : "DBSS"
    },
    "severity" : 3,
    "create_time" : 1700000000000,
    "device_ip" : "192.168.0.1",
    "status" : "PROCESSED",
    "count" : 10,
    "description" : "检测到针对数据库的SQL注入攻击行为,存在数据泄露风险"
  } ]
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

相关文档