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

导出告警

功能介绍

导出告警,若字段是object类型,则将整个子对象的内容导出

调用方法

请参见如何调用API

URI

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

表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 请求Body参数

参数

是否必选

参数类型

描述

data_object_filters_form

DataobjectSearch object

搜索列表条件

title

Array of strings

导出字段

表4 DataobjectSearch

参数

是否必选

参数类型

描述

limit

Integer

分页大小

offset

Integer

偏移量

sort_by

String

排序字段:create_time | update_time

order

String

排序方式:DESC | ASC

from_date

String

搜索开始时间,例如:2023-02-20T00:00:00.000Z

to_date

String

搜索结束时间,例如:2023-02-27T23:59:59.999Z

condition

condition object

搜索条件表达式

表5 condition

参数

是否必选

参数类型

描述

conditions

Array of conditions objects

表达式列表

logics

Array of strings

表达式名称列表

表6 conditions

参数

是否必选

参数类型

描述

name

String

表达式名称

data

Array of strings

表达式内容列表

响应参数

状态码:200

告警导出结果文件

状态码:400

表7 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

响应示例

状态码

状态码

描述

200

告警导出结果文件

400

导出告警错误返回body体

错误码

请参见错误码

相关文档