更新时间:2022-06-15 GMT+08:00
分享

操作execution

功能介绍

启动/停止/更新执行任务。

停止任务成功后即停止下发新Job至环境,已下发的Job将持续运行直至自然结束。若想停止Job,请在环境对应的服务内删除Job,或直接删除该任务。

URI

PUT /v1/executions/{execution_id}

表1 参数说明

参数

是否必选

参数类型

描述

execution_id

String

执行结果ID,即创建execution接口返回值。

请求消息

请求参数

请求参数如表2所示。

表2 请求参数

参数

是否必选

参数类型

取值范围

描述

action

String

cancel/retry/update

执行结果操作名称,支持选项为:

  • cancel: 取消
  • retry: 重试
  • update: 更新priority

inputs_json

Map

根据其流程定义

流程输入参数,当为空时,将使用流程文件的inputs中定义的默认值。

timeout

Integer64

为空取默认值,默认值为1440分钟

超时时间,如果不填,则默认是1440分钟。

priority

Integer64

默认值为0,取值范围[0,999]

execution的调度优先级,默认值为0,取值范围[0,999]。数值越高优先级越高。

请求示例

PUT /v1/executions/e19d3faf-9f04-9685-e5c0-fbe8d40b96cd HTTP/1.1 
Host:Host Server   
Content-Type:application/json
{
    "action": "cancel",
 }

响应消息

响应参数

请求成功的响应参数如表3所示。

表3 成功响应参数

参数

参数类型

描述

id

String

执行结果ID。

响应示例

{
    "id": "e19d3faf-9f04-9685-e5c0-fbe8d40b96cd"
}

请求失败的响应参数如表9所示。

状态码

  • 正常

    状态码如表4所示。

表4 状态码

状态码

描述

200

操作执行任务成功。

相关文档