文档首页/ 安全云脑 SecMaster/ API参考/ API V2/ 流程管理/ 创建流程
更新时间：2025-08-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建流程

功能介绍

创建流程

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/workflows

表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参数

参数

是否必选

参数类型

描述

name

是

String

参数解释:

流程名称

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

description

否

String

参数解释:

流程的描述

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

engine_type

是

String

参数解释:

引擎的类型

  • public_engine 共享版

约束限制:

不涉及

取值范围:

  • public_engine

默认值:

不涉及

aop_type

是

String

参数解释:

流程的类型

  • NORMAL 通用

  • SURVEY 调查

  • HEMOSTASIS 止血

  • EASE 缓解

约束限制:

不涉及

取值范围:

  • NORMAL

  • SURVEY

  • HEMOSTASIS

  • EASE

默认值:

不涉及

dataclass_id

是

String

参数解释:

数据类的ID

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

labels

否

String

参数解释:

流程实体类型

  • IP IP

  • ACCOUNT 账号

  • DOMAIN 域名

约束限制:

不涉及

取值范围:

  • IP

  • ACCOUNT

  • DOMAIN

默认值:

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

data

AopWorkflowInfo object

流程详情
表5 AopWorkflowInfo

参数

参数类型

描述

id

String

参数解释:

流程ID

取值范围:

不涉及

name

String

参数解释:

流程名称

取值范围:

不涉及

description

String

参数解释:

流程的描述

取值范围:

不涉及

project_id

String

参数解释:

租户ID

取值范围:

不涉及

owner_id

String

参数解释:

所有者ID

取值范围:

不涉及

creator_id

String

参数解释:

创建者ID

取值范围:

不涉及

edit_role

String

参数解释:

编辑角色

取值范围:

不涉及

use_role

String

参数解释:

使用角色

取值范围:

不涉及

approve_role

String

参数解释:

审核角色

取值范围:

不涉及

enabled

Boolean

参数解释:

是否已启用

取值范围:

  • true 已启用

  • fasle 未启用

workspace_id

String

参数解释:

工作空间ID

取值范围:

不涉及

version_id

String

参数解释:

流程激活版本ID

取值范围:

不涉及

current_approval_version_id

String

参数解释:

当前待审核版本ID

取值范围:

不涉及

current_rejected_version_id

String

参数解释:

当前拒绝的版本ID

取值范围:

不涉及

aop_type

String

参数解释:

流程的类型

  • NORMAL 通用

  • SURVEY 调查

  • HEMOSTASIS 止血

  • EASE 缓解

取值范围:

  • NORMAL

  • SURVEY

  • HEMOSTASIS

  • EASE

engine_type

String

参数解释:

引擎的类型

  • public_engine 共享版

取值范围:

  • public_engine

dataclass_id

String

参数解释:

数据类的ID

取值范围:

不涉及

labels

String

参数解释:

流程实体类型

  • IP IP

  • ACCOUNT 账号

  • DOMAIN 域名

取值范围:

  • IP

  • ACCOUNT

  • DOMAIN

状态码：400

表6 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

创建一个名称是Test_aop的流程

https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/workflows

{
  "name" : "Test_aop",
  "dataclass_id" : "e410ae50-43fa-343e-807a-a2a9edb8018e",
  "aop_type" : "NORMAL",
  "engine_type" : "public_engine",
  "description" : "Aop workflow description",
  "labels" : "IP"
}

响应示例

状态码：200

Response of creating aopworkflow

{
  "code" : "00000000",
  "data" : {
    "aopSource" : "",
    "aop_type" : "NORMAL",
    "approve_role" : "",
    "create_time" : "2025-07-18T14:44:46.735Z+0800",
    "creator_id" : "5857617f6b8b4981baef587c08ab8b68",
    "creator_name" : "w60063692",
    "current_approval_version_id" : "",
    "current_rejected_version_id" : "",
    "dataclass_id" : "e410ae50-43fa-343e-807a-a2a9edb8018e",
    "dataclass_name" : "",
    "description" : "Aop workflow description",
    "domain_id" : "",
    "edit_role" : "",
    "enabled" : false,
    "engine_type" : "public_engine",
    "favorite" : null,
    "id" : "c19470f3-5eaf-4572-82e8-2ff094495919",
    "labels" : "IP",
    "modifier_id" : "",
    "modifier_name" : "",
    "name" : "Test_aop",
    "owner_id" : "",
    "project_id" : "f69081793d9e4ea8a2f479dcef961989",
    "update_time" : "2025-07-18T14:44:46.735Z+0800",
    "use_role" : "",
    "version" : "",
    "version_id" : "",
    "workspace_id" : "f44065f5-557b-4376-ae02-8c65ef1960f4"
  },
  "message" : "",
  "request_id" : "",
  "success" : true
}

状态码

状态码

描述

200

Response of creating aopworkflow

400

Error response

错误码

请参见错误码。

父主题： 流程管理

相关文档