文档首页/ 安全云脑 SecMaster/ API参考/ 安全云脑 API V1/ 流程实例管理/ 更新流程实例 - UpdateWorkflowInstance
更新时间：2026-01-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新流程实例 - UpdateWorkflowInstance

功能介绍

更新流程实例

调用方法

请参见如何调用API。

授权信息

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

URI

PUT /v1/{project_id}/workspaces/{workspace_id}/soc/workflows/instances/{instance_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

workspace_id

是

String

参数解释:

工作空间ID

取值范围:

不涉及

instance_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

参数解释:

更新流程实例的指令

  • ActionInstanceTerminateCommand 终止流程实例

  • ActionInstanceRetryCommand 重试流程实例

  • ActionInstanceDebugCommand 更新流程实例的调试结果

约束限制:

当command_type=ActionInstanceDebugCommand时task_id和inputdataobject是必填参数

取值范围:

  • ActionInstanceTerminateCommand

  • ActionInstanceRetryCommand

  • ActionInstanceDebugCommand

默认值:

不涉及

task_id

否

String

参数解释:

更新流程调试实例节点ID

约束限制:

当command_type=ActionInstanceDebugCommand时参数为必填参数

取值范围:

不涉及

默认值:

不涉及

input_dataobject

否

String

参数解释:

更新流程调试实例节点参数

约束限制:

当command_type=ActionInstanceDebugCommand时参数为必填参

取值范围:

不涉及

默认值:

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

success

Boolean

参数解释:

是否成功

取值范围:

  • true 成功

  • false 失败

request_id

String

参数解释:

请求的ID

约束限制:

不涉及

状态码：400

表5 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

  • 重试流程实例的样例

    {
  "command_type" : "ActionInstanceRetryCommand"
}

  • 终止流程实例的样例

    {
  "command_type" : "ActionInstanceTerminateCommand"
}

  • 更新流程调试结果的样例

    {
  "command_type" : "ActionInstanceDebugCommand",
  "task_id" : "b5848121-79a5-11f0-9f91-fa163ed04a7f",
  "input_dataobject" : "[{\"readonly\":false,\"extra\":\"\",\"name\":\"uuid\",\"description\":\"UUID\",\"default_value\":\"\",\"type\":\"String\",\"value\":{\"output\":{\"uuid\":\"11f8ebde-ee67-431b-afa9-3e31d8a29ae7\"}},\"key\":\"SecMasterUtilities\",\"required\":false},{\"readonly\":false,\"extra\":\"\",\"name\":\"uuid\",\"description\":\"UUID\",\"default_value\":\"\",\"type\":\"String\",\"value\":{\"output\":{\"uuid\":\"11f8ebde-ee67-431b-afa9-3e31d8a29ae7\"}},\"key\":\"Activity_1atma47\",\"required\":false}]"
}

响应示例

状态码：200

更新流程实例的响应

{
  "code" : "00000000",
  "message" : "",
  "request_id" : "",
  "success" : true
}

状态码

状态码

描述

200

更新流程实例的响应

400

异常的响应

错误码

请参见错误码。

父主题： 流程实例管理

相关文档