文档首页/ 安全云脑 SecMaster/ API参考/ 安全云脑 API V1/ 流程实例管理/ 创建流程实例 - CreateWorkflowInstance
更新时间:2026-02-05 GMT+08:00
分享

创建流程实例 - 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" : { }
      }
    }
  }
}

SDK代码示例

SDK代码示例如下。

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.secmaster.v1.region.SecMasterRegion;
import com.huaweicloud.sdk.secmaster.v1.*;
import com.huaweicloud.sdk.secmaster.v1.model.*;

import java.util.Map;
import java.util.HashMap;

public class CreateWorkflowInstanceSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        SecMasterClient client = SecMasterClient.newBuilder()
                .withCredential(auth)
                .withRegion(SecMasterRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateWorkflowInstanceRequest request = new CreateWorkflowInstanceRequest();
        request.withWorkspaceId("{workspace_id}");
        request.withWorkflowId("{workflow_id}");
        AopInstanceEventData body = new AopInstanceEventData();
        DataClassRef dataclassDataObject = new DataClassRef();
        dataclassDataObject.withName("Alert");
        Map<String, Object> listDataObjectContent = new HashMap<>();
        listDataObjectContent.put("name", new Object());
        listDataObjectContent.put("key", new Object());
        DataObjectRefInfo dataObjectPlaybookContext = new DataObjectRefInfo();
        dataObjectPlaybookContext.withContent(listDataObjectContent)
            .withDataclass(dataclassDataObject);
        PlaybookcontextRef playbookContextbody = new PlaybookcontextRef();
        playbookContextbody.withDataObject(dataObjectPlaybookContext);
        body.withPlaybookContext(playbookContextbody);
        body.withActionInstanceId("1111xxxxxxxxxxxxxx111");
        body.withActionId("446255ce-XXXXXXXXXX-0b4931");
        body.withActionType(AopInstanceEventData.ActionTypeEnum.fromValue("workflow"));
        body.withCommandType(AopInstanceEventData.CommandTypeEnum.fromValue("ActionInstanceRunCommand"));
        request.withBody(body);
        try {
            CreateWorkflowInstanceResponse response = client.createWorkflowInstance(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksecmaster.v1.region.secmaster_region import SecMasterRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksecmaster.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = SecMasterClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateWorkflowInstanceRequest()
        request.workspace_id = "{workspace_id}"
        request.workflow_id = "{workflow_id}"
        dataclassDataObject = DataClassRef(
            name="Alert"
        )
        listContentDataObject = {
            "name": {},
            "key": {}
        }
        dataObjectPlaybookContext = DataObjectRefInfo(
            content=listContentDataObject,
            dataclass=dataclassDataObject
        )
        playbookContextbody = PlaybookcontextRef(
            data_object=dataObjectPlaybookContext
        )
        request.body = AopInstanceEventData(
            playbook_context=playbookContextbody,
            action_instance_id="1111xxxxxxxxxxxxxx111",
            action_id="446255ce-XXXXXXXXXX-0b4931",
            action_type="workflow",
            command_type="ActionInstanceRunCommand"
        )
        response = client.create_workflow_instance(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := secmaster.NewSecMasterClient(
        secmaster.SecMasterClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateWorkflowInstanceRequest{}
	request.WorkspaceId = "{workspace_id}"
	request.WorkflowId = "{workflow_id}"
	dataclassDataObject := &model.DataClassRef{
		Name: "Alert",
	}
	var listContentDataObject = map[string]interface{}{
        "name": make(map[string]string),
        "key": make(map[string]string),
    }
	dataObjectPlaybookContext := &model.DataObjectRefInfo{
		Content: listContentDataObject,
		Dataclass: dataclassDataObject,
	}
	playbookContextbody := &model.PlaybookcontextRef{
		DataObject: dataObjectPlaybookContext,
	}
	actionInstanceIdAopInstanceEventData:= "1111xxxxxxxxxxxxxx111"
	actionIdAopInstanceEventData:= "446255ce-XXXXXXXXXX-0b4931"
	request.Body = &model.AopInstanceEventData{
		PlaybookContext: playbookContextbody,
		ActionInstanceId: &actionInstanceIdAopInstanceEventData,
		ActionId: &actionIdAopInstanceEventData,
		ActionType: model.GetAopInstanceEventDataActionTypeEnum().WORKFLOW,
		CommandType: model.GetAopInstanceEventDataCommandTypeEnum().ACTION_INSTANCE_RUN_COMMAND,
	}
	response, err := client.CreateWorkflowInstance(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

操作流程实例的响应

错误码

请参见错误码

相关文档