# 创建流程实例 - CreateWorkflowInstance #### 功能介绍 创建流程实例 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-secmaster/secmaster_03_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-secmaster/secmaster_03_0023.html)。 #### URI POST /v1/{project_id}/workspaces/{workspace_id}/soc/workflows/{workflow_id}/instances 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。[获取项目ID](https://support.huaweicloud.com/api-secmaster/secmaster_03_0014.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | workspace_id | 是 | String | **参数解释**: 工作空间ID **取值范围**: 不涉及 | | workflow_id | 是 | String | 流程ID | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。[获取用户Token](https://support.huaweicloud.com/api-secmaster/secmaster_03_0010.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | 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 | 运行的上下文 | 表4PlaybookcontextRef | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | data_object | 是 | [DataObjectRefInfo] object | 运行流程的上下文 | 表5DataObjectRefInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | content | 否 | Map\ | 流程实例上下文内容 | | dataclass | 否 | [DataClassRef] object | 数据类信息 | 表6DataClassRef | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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 | 运行的上下文 | 表8PlaybookcontextRef | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data_object | [DataObjectRefInfo] object | 运行流程的上下文 | 表9DataObjectRefInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | content | Map\ | 流程实例上下文内容 | | dataclass | [DataClassRef] object | 数据类信息 | 表10DataClassRef | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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代码示例如下。 - [Java] 运行告警数据类的流程实例 ``` 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("")) .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 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()); } } } ``` - [Python] 运行告警数据类的流程实例 ``` # 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("")) \ .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) ``` - [Go] 运行告警数据类的流程实例 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := secmaster.NewSecMasterClient(hcClient) 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](https://console.huaweicloud.com/apiexplorer/#/openapi/SecMaster/sdk?api=CreateWorkflowInstance&version=v1)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 操作流程实例的响应 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。