文档首页/ 安全云脑 SecMaster/ API参考（吉隆坡区域）/ API/ 剧本规则管理/ 创建剧本规则
更新时间：2025-07-04 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建剧本规则

功能介绍

创建剧本规则

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/versions/{version_id}/rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

workspace_id

是

String

工作空间ID

version_id

是

String

剧本版本ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

content-type

是

String

application/json;charset=UTF-8
表3 请求Body参数

参数

是否必选

参数类型

描述

rule

是

ConditionInfo object

剧本触发规则详情
表4 ConditionInfo

参数

是否必选

参数类型

描述

expression_type

否

String

表达式类型。默认为common,事件触发剧本必填

conditions

否

Array of ConditionItem objects

触发条件。事件触发剧本必填

logics

否

Array of strings

条件逻辑组合。事件触发剧本必填

cron

否

String

Cron 表达式（定时任务）。定时触发剧本必填

schedule_type

否

String

定时重复类型(second--秒, hour--小时,day--天，week-周)。定时触发剧本必填

start_type

否

String

剧本开始执行类型，IMMEDIATELY--创建完成立即执行, CUSTOM--自定义执行时间。定时触发剧本必填

end_type

否

String

剧本结束执行类型，FOREVER--一直执行, CUSTOM--自定义结束时间。定时触发剧本必填

end_time

否

String

定时结束时间。定时触发剧本必填

repeat_range

否

String

执行时间段 2021-01-30T23:00:00Z+0800。定时触发剧本必填

only_once

否

Boolean

是否只执行一次。定时触发剧本必填

execution_type

否

String

执行队列类型（PARALLEL-新任务与之前任务并行）。定时触发剧本必填
表5 ConditionItem

参数

是否必选

参数类型

描述

name

否

String

条件名称

detail

否

String

条件详情

data

否

Array of strings

条件表达式数据

响应参数

状态码：200

表6 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为：request_uuid-timestamp-hostname
表7 响应Body参数

参数

参数类型

描述

code

String

错误码

message

String

错误信息

data

RuleInfo object

剧本触发规格信息
表8 RuleInfo

参数

参数类型

描述

id

String

规则ID

project_id

String

项目ID

rule

String

触发规则

状态码：400

表9 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为：request_uuid-timestamp-hostname
表10 响应Body参数

参数

参数类型

描述

code

String

错误码

message

String

错误描述

请求示例

创建一条剧本规则，名称为condition_0，表达式类型为所有，

{
  "rule" : {
    "expression_type" : "common",
    "conditions" : [ {
      "name" : "condition_0",
      "detail" : "123",
      "data" : [ "handle_status, ==, Open" ]
    } ],
    "logics" : [ "condition_0" ]
  }
}

响应示例

状态码：200

请求成功响应信息

{
  "code" : 0,
  "message" : "",
  "data" : {
    "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "rule" : "{\"expression_type\":\"common\",\"conditions\":[{\"name\":\"condition_0\",\"data\":[\"ref_order_id\",\"==\",\"123\"],\"detail\":\"123\"}],\"logics\":[\"condition_0\"]}"
  }
}

状态码

状态码

描述

200

请求成功响应信息

400

请求失败响应信息

错误码

请参见错误码。

父主题： 剧本规则管理