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

导出模型 - ExportAlertRule

功能介绍

导出指定的告警规则配置信息

调用方法

请参见如何调用API。

授权信息

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

URI

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

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

参数

是否必选

参数类型

描述

alert_rule_ids

是

Array of strings

参数解释:

要导出的告警规则ID列表,可通过查询告警规则列表接口获取。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

-

File

参数解释:

导出的告警规则模型文件,包含告警规则配置信息的压缩包文件,格式为zip。解压后包含yaml格式的告警规则定义文件。

请求示例

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

响应示例

状态码:200

"alert_YYYYMMDDHHmmss.zip"

状态码

状态码

描述

200

请求成功

错误码

请参见错误码。

相关文档