文档首页/ 数据安全中心 DSC/ API参考/ API/ 告警管理/ 告警管理-修改告警信息 - UpdateAlarmInfo
更新时间:2026-11-13 GMT+08:00
分享

告警管理-修改告警信息 - UpdateAlarmInfo

功能介绍

功能介绍:修改告警信息。按路径 alarm_id 更新告警名称、类型、级别、状态、验证状态、来源信息、受影响资产及描述等字段。

响应:请求成功返回HTTP 200,响应体仅包含 status。

接口约束

  • 无特殊约束。

调用方法

请参见如何调用API。

授权信息

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

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

URI

PUT /v2/{project_id}/security-op/alarm/{alarm_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

alarm_id

是

Long

参数解释:

告警ID,用于唯一标识一条告警记录,可通过调用查询告警列表接口获取

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

id

否

Long

参数解释:

告警ID,用于唯一标识该告警,可通过调用查询告警列表接口获取

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

alarm_name

否

String

参数解释:

告警信息名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

alarm_type

是

String

参数解释:

告警信息类型(告警子类型)

约束限制:

不涉及

取值范围:

  • SQL_INJECTION-SQL注入

  • RISK_OPERATION-风险操作

  • ILLEGAL_ACCESS-非法访问

  • LOGIN_SECURITY-登录安全

  • INTERFACE_SECURITY-接口安全

  • BUSSINESS_SECURITY-业务安全

  • DATA_SECURITY-数据安全

默认取值:

不涉及

alarm_level

是

String

参数解释:

告警信息等级

约束限制:

不涉及

取值范围:

  • NOTICE_RISK-提示

  • LOW_RISK-低危

  • MIDDLE_RISK-中危

  • HIGH_RISK-高危

  • FATAL_RISK-致命

默认取值:

不涉及

alarm_status

是

String

参数解释:

告警信息状态

约束限制:

不涉及

取值范围:

  • OPEN-未关闭

  • CLOSE-关闭

  • BLOCK-阻断

默认取值:

不涉及

verification_status

是

String

参数解释:

告警核实状态,用于标识该告警的核实处理结果

约束限制:

不涉及

取值范围:

  • NEED-待处理

  • CONFIRM-确认

  • MIS-误判

  • EXCLUDE-排除

默认取值:

不涉及

source_module

否

String

参数解释:

来源模块

约束限制:

不涉及

取值范围:

  • DBSS-数据库安全服务

  • CBH-堡垒机

  • DATABASE_ENCRYPT-数据库加密

  • DATABASE_OP-数据库运维

  • API-API接口

默认取值:

不涉及

source_client_ip

否

String

参数解释:

源客户端IP

约束限制:

满足 IPv4 或 IPv6 地址格式

取值范围:

不涉及

默认取值:

不涉及

source_instance

否

source_instance object

参数解释:

来源实例信息

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

responsible_person

否

responsible_person object

参数解释:

责任人信息

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

affected_asset

否

Array of strings

参数解释:

受影响的资产名称或ID列表,数组元素为String类型

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

create_time

否

Long

参数解释:

创建时间,13位毫秒级Unix时间戳

约束限制:

不涉及

取值范围:

13位时间戳(毫秒)

默认取值:

不涉及

occur_time

否

Long

参数解释:

告警发生时间,13位毫秒级Unix时间戳

约束限制:

不涉及

取值范围:

13位时间戳(毫秒)

默认取值:

不涉及

disposal_suggestion

否

String

参数解释:

处置建议

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

description

否

String

参数解释:

告警描述信息

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表4 source_instance

参数

是否必选

参数类型

描述

instance_id

否

String

参数解释:

实例ID

取值范围:

不涉及

instance_name

否

String

参数解释:

实例名称

取值范围:

不涉及

表5 responsible_person

参数

是否必选

参数类型

描述

user_id

否

String

参数解释:

用户ID

取值范围:

不涉及

user_name

否

String

参数解释:

用户名

取值范围:

不涉及

响应参数

状态码:200

表6 响应Body参数

参数

参数类型

描述

status

String

参数解释:

请求状态,success表示成功。

取值范围:

不涉及

msg

String

参数解释:

提示信息

取值范围:

不涉及

id

String

参数解释:

资源ID,唯一标识操作返回对应的资源对象

取值范围:

不涉及

请求示例

无

响应示例

状态码:200

{
  "status" : "success"
}

状态码

状态码

描述

200

更新成功

错误码

请参见错误码。

相关文档