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

导入告警

功能介绍

批量导入告警,根据template下载的模板填写告警,告警的所有字段根据是否必填来限制,参照:安全事件数据对象定义中的类型和说明来确定, 后台实现时需要校验

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/alerts/import

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

参数解释:

工作空间id。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

content-type

String

参数解释:

内容类型

  • application/json;charset=UTF-8 普通API请求的类型

约束限制:

不涉及

取值范围:

  • application/json;charset=UTF-8

默认取值:

不涉及

表3 FormData参数

参数

是否必选

参数类型

描述

uploadFile

File

导入告警文件

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

code

String

错误码

message

String

错误信息

data

data object

告警导入结果返回数据

表5 data

参数

参数类型

描述

ids

Array of strings

导入的告警id列表

状态码:400

表6 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

响应示例

状态码

状态码

描述

200

导入告警返回body体

400

导入告警错误返回body体

错误码

请参见错误码

相关文档