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

创建流程实例 - CreateWorkflowInstance

功能介绍

创建流程实例

调用方法

请参见如何调用API。

授权信息

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

workspace_id

是

String

参数解释:

工作空间ID

取值范围:

不涉及

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

参数

是否必选

参数类型

描述

command_type

是

String

参数解释:

操作流程实例的指令

  • ActionInstanceRunCommand 运行流程实例

约束限制:

不涉及

取值范围:

  • ActionInstanceRunCommand

默认值:

不涉及

action_type

是

String

参数解释:

action的类型

  • workflow 流程

约束限制:

不涉及

取值范围:

  • workflow

默认值:

不涉及

action_id

否

String

参数解释:

流程的ID

约束限制:

不涉及

action_instance_id

否

String

参数解释:

流程实例的ID

约束限制:

不涉及

playbook_context

否

PlaybookcontextRef object

运行的上下文
表4 PlaybookcontextRef

参数

是否必选

参数类型

描述

data_object

是

DataObjectRefInfo object

运行流程的上下文
表5 DataObjectRefInfo

参数

是否必选

参数类型

描述

content

否

Map<String,Object>

流程实例上下文内容

dataclass

否

DataClassRef object

数据类信息
表6 DataClassRef

参数

是否必选

参数类型

描述

id

否

String

参数解释:

数据类的ID

取值范围:

不涉及

name

是

String

参数解释:

数据类的名称

取值范围:

不涉及

响应参数

状态码：200

表7 响应Body参数

参数

参数类型

描述

command_type

String

参数解释:

操作流程实例的指令

  • ActionInstanceRunCommand 运行流程实例

约束限制:

不涉及

取值范围:

  • ActionInstanceRunCommand

默认值:

不涉及

action_type

String

参数解释:

action的类型

  • workflow 流程

约束限制:

不涉及

取值范围:

  • workflow

默认值:

不涉及

action_id

String

参数解释:

流程的ID

约束限制:

不涉及

action_instance_id

String

参数解释:

流程实例的ID

约束限制:

不涉及

playbook_context

PlaybookcontextRef object

运行的上下文
表8 PlaybookcontextRef

参数

参数类型

描述

data_object

DataObjectRefInfo object

运行流程的上下文
表9 DataObjectRefInfo

参数

参数类型

描述

content

Map<String,Object>

流程实例上下文内容

dataclass

DataClassRef object

数据类信息
表10 DataClassRef

参数

参数类型

描述

id

String

参数解释:

数据类的ID

取值范围:

不涉及

name

String

参数解释:

数据类的名称

取值范围:

不涉及

请求示例

运行告警数据类的流程实例

{
  "command_type" : "ActionInstanceRunCommand",
  "action_type" : "workflow",
  "action_id" : "446255ce-XXXXXXXXXX-0b4931",
  "action_instance_id" : "1111xxxxxxxxxxxxxx111",
  "playbook_context" : {
    "data_object" : {
      "dataclass" : {
        "name" : "Alert"
      },
      "content" : {
        "name" : { },
        "key" : { }
      }
    }
  }
}

响应示例

状态码：200

操作流程实例的响应

{
  "command_type" : "ActionInstanceRunCommand",
  "action_type" : "workflow",
  "action_id" : "446255ce-XXXXXXXXXX-0b4931",
  "action_instance_id" : "1111xxxxxxxxxxxxxx111",
  "playbook_context" : {
    "data_object" : {
      "dataclass" : {
        "name" : "Alert"
      },
      "content" : {
        "name" : { },
        "key" : { }
      }
    }
  }
}

状态码

状态码

描述

200

操作流程实例的响应

错误码

请参见错误码。

父主题： 流程实例管理

相关文档