更新时间:2026-09-30 GMT+08:00
分享

导入模型 - ImportAlertRule

功能介绍

导入告警规则配置文件

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。

URI

POST /v2/{project_id}/workspaces/{workspace_id}/siem/alert-rules/import

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

是

String

参数解释:

工作空间ID,用于标识安全云脑中的工作空间,确定操作所属的工作空间范围。可以通过调用API获取,也可以从控制台获取。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 FormData参数

参数

是否必选

参数类型

描述

file

是

File

参数解释:

要导入的告警规则模型定义文件,包含告警规则配置信息的zip或yml格式文件,可通过导出告警规则接口获取。

约束限制:

  • 文件支持zip和yml格式

  • 文件长度不超过100000KB

  • 文件名称长度不超过128字符

import_mode

是

String

参数解释:

导入模式,用于指定导入告警规则时对已有同名规则的处理方式。

约束限制:

不涉及

取值范围:

  • overwrite:覆盖模式,导入时覆盖已有的同名告警规则

  • reserved:保留模式,导入时保留已有的同名告警规则,跳过冲突项

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data

data object

参数解释:

导入告警规则的响应体数据

取值范围:

不涉及

表5 data

参数

参数类型

描述

fail_count

Integer

参数解释:

导入失败的告警规则数量

取值范围:

不涉及

success_count

Integer

参数解释:

导入成功的告警规则数量

取值范围:

不涉及

result

Array of result objects

参数解释:

导入结果列表,包含每条告警规则的导入详情,具体请参见result数据结构。

表6 result

参数

参数类型

描述

alert_rule_name

String

参数解释:

告警规则名称

取值范围:

不涉及

msg

String

参数解释:

导入过程中的消息提示,可能为null

取值范围:

不涉及

success

Boolean

参数解释:

该条告警规则是否导入成功。

取值范围:

  • true:导入成功

  • false:导入失败

请求示例

https://{endpoint}/v2/{project_id}/workspaces/{workspace_id}/siem/alert-rules/import

响应示例

无

状态码

状态码

描述

200

请求成功

错误码

请参见错误码。

相关文档