管理Workflow Execution - CreateWorkflowExecutionsActions

功能介绍

管理Workflow Execution接口用于对指定工作流执行实例进行操作，如启动、暂停或终止。

该接口适用于以下场景：当用户需要控制工作流执行实例的运行状态、处理执行异常或调整执行流程时，可通过此接口对指定的执行实例进行管理。使用该接口的前提条件是目标执行实例已存在且用户具有管理权限，且执行实例处于可操作状态（如运行中或暂停状态）。管理操作完成后，执行实例的状态将被更新，相关资源和配置也将被调整。若执行实例不存在、用户无权限操作或执行实例状态不允许操作，接口将返回相应的错误信息。

接口约束

无

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
modelarts:workflow:execute
Write
workflow *
-
-
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
modelarts:workflow:execute	Write	workflow *	-	-	-

URI

POST /v2/{project_id}/workflows/{workflow_id}/executions/{execution_id}/actions

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：用户项目ID。获取方法请参见获取项目ID和名称。约束限制：1 - 64字符，字母、数字和中划线。取值范围：不涉及。默认取值：不涉及。
workflow_id	是	String	参数解释：工作流的ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
execution_id	是	String	参数解释：工作流执行ID，获取方法请参见获取Execution列表。约束限制：uuid。取值范围：不涉及。默认取值：不涉及。

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
action_name	是	String	参数解释：操作名称。约束限制：不涉及。取值范围：枚举如下: stop：停止 rerun：重跑默认取值：不涉及。
policies	否	ExecutionActionPolicy object	参数解释：动作策略。约束限制：不涉及。
parameters	否	Array of WorkflowParameter objects	参数解释：参数。约束限制：不涉及。
data_requirements	否	Array of DataRequirement objects	参数解释：需要的数据。约束限制：不涉及。

表3 ExecutionActionPolicy
参数	是否必选	参数类型	描述
rerun_steps	否	Array of strings	参数解释：重跑的节点。约束限制：不涉及。

表4 WorkflowParameter
参数	是否必选	参数类型	描述
name	否	String	参数解释：Workflow工作流配置参数的名称。约束限制：长度为1-64位，仅包含英文、数字、下划线（_）和中划线（-），并且以英文开头的名称。取值范围：不涉及。默认取值：不涉及。
type	否	String	参数解释：参数的类型。约束限制：不涉及。取值范围：枚举值如下: str：字符串 int：整型 bool：布尔类型 float：浮点型默认取值：不涉及。
description	否	String	参数解释：Workflow工作流配置参数的描述。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
example	否	Object	参数解释：Workflow工作流配置参数的样例。约束限制：不涉及。
delay	否	Boolean	参数解释：是否为延迟输入的参数。约束限制：不涉及。取值范围： true：是 false：否默认取值：默认为否。
default	否	Object	参数解释：配置参数的默认值。约束限制：不涉及。
value	否	Object	参数解释：参数值。约束限制：不涉及。
enum	否	Array of objects	参数解释：Workflow工作流配置参数的枚举项。约束限制：不涉及。
used_steps	否	Array of strings	参数解释：使用这个参数的工作流节点。约束限制：不涉及。
format	否	String	参数解释：数据格式。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
constraint	否	Map<String,Object>	参数解释：限制条件。约束限制：不涉及。

表5 DataRequirement
参数	是否必选	参数类型	描述
name	是	String	参数解释：训练数据的名称。约束限制：长度为1-64位，仅包含英文、数字、下划线（_）和中划线（-），并且以英文开头的名称。取值范围：不涉及。默认取值：不涉及。
type	是	String	参数解释：数据来源类型。约束限制：不涉及。取值范围：枚举值如下： dataset：数据集 obs：OBS swr：SWR model_list：AI应用列表 label_task：标注任务 service：在线服务默认取值：不涉及。
conditions	否	Array of Constraint objects	参数解释：数据约束条件。约束限制：不涉及。
value	否	Map<String,Object>	参数解释：数据的值。约束限制：不涉及。
used_steps	否	Array of strings	参数解释：使用了这条数据的工作流节点。约束限制：不涉及。
delay	否	Boolean	参数解释：延时参数标记。约束限制：不涉及。取值范围： true：延时 false：不延时默认取值：不涉及。

表6 Constraint
参数	是否必选	参数类型	描述
attribute	否	String	参数解释：条件属性，参数的某个字段值。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
operator	否	String	参数解释：操作。约束限制：当前只支持equal操作。取值范围：不涉及。默认取值：不涉及。
value	否	Object	参数解释：取值。约束限制：不涉及。

响应参数

状态码：201

表7 响应Body参数
参数	参数类型	描述
created_at	String	参数解释：创建时间。取值范围：不涉及。
name	String	参数解释：执行记录名称。取值范围：不涉及。
execution_id	String	参数解释：工作流执行ID。获取方法请参见获取Execution列表。。取值范围：不涉及。
description	String	参数解释：执行记录描述。取值范围：不涉及。
status	String	参数解释：执行记录状态。取值范围：枚举值如下： init：初始化 running：运行中 completed：运行成功 stopped：已停止 abnormal：异常
workspace_id	String	参数解释：工作空间ID。获取方法请参见查询工作空间列表。取值范围：不涉及。
workflow_id	String	参数解释：Workflow工作流ID。取值范围：不涉及。
workflow_name	String	参数解释：工作流名称。取值范围：不涉及。
scene_id	String	参数解释：自定义场景ID，获取方法请参见查询工作流执行记录列表。取值范围：不涉及。
scene_name	String	参数解释：自定义场景名称。取值范围：不涉及。
steps_execution	Array of StepExecutionResp objects	参数解释：执行记录的step。约束限制：不涉及。
sub_graphs	Array of WorkflowSubgraphResp objects	参数解释：子图。
duration	String	参数解释：执行的时长。取值范围：不涉及。
events	Array of strings	参数解释：执行的事件。
labels	Array of strings	参数解释：为执行记录设置的标签。
data_requirements	Array of DataRequirementResp objects	参数解释：节点steps使用到的数据。
parameters	Array of WorkflowParameterResp objects	参数解释：节点steps使用到的参数。
policies	WorkflowDagPoliciesResp object	参数解释：执行记录使用到的执行策略。

表8 StepExecutionResp
参数	参数类型	描述
step_name	String	参数解释：节点的名称，在一个DAG中唯一。取值范围：不涉及。
execution_name	String	参数解释：执行记录的名称。取值范围：不涉及。
name	String	参数解释：执行记录与节点的组合名称。取值范围：不涉及。
uuid	String	参数解释：唯一标识uuid。创建节点执行时，后台自动生成。取值范围：不涉及。
execution_uuid	String	参数解释：执行记录的UUID。取值范围：不涉及。
created_at	String	参数解释：Execution执行的创建时间。取值范围：不涉及。
updated_at	String	参数解释：Execution执行的更新时间。取值范围：不涉及。
duration	Integer	参数解释：Execution执行的运行时长。取值范围：不涉及。
type	String	参数解释：节点的类型。取值范围：枚举值如下: job：训练 labeling：标注 release_dataset：数据集发布 model：模型发布 service：服务部署 mrs_job：MRS作业 dataset_import：数据集导入 create_dataset：创建数据集
instance_id	String	参数解释：实例ID。取值范围：不涉及。
status	String	参数解释：节点的状态。取值范围：枚举值如下： init：初始化 wait_inputs：等待输入 pending：等待 creating：创建中 created：创建成功 create_failed：创建失败 running：运行中 stopping：停止中 stopped：停止 timeout：超时 completed：完成 failed：失败 hold：暂停 skipped：跳过
inputs	Array of JobInputResp objects	参数解释：节点的输入项。
outputs	Array of JobOutputResp objects	参数解释：节点的输出项。
step_uuid	String	参数解释：节点的UUID，唯一性标识。取值范围：不涉及。
properties	Map<String,String>	参数解释：节点的属性。
events	Array of strings	参数解释：节点发生的事件。
error_info	WorkflowErrorInfoResp object	参数解释：Execution执行的错误信息。
policy	WorkflowStepExecutionPolicyResp object	参数解释：节点的执行策略。
conditions_execution	WorkflowConditionExecutionResp object	参数解释：条件执行。
step_title	String	参数解释：节点标题。取值范围：不涉及。
conditions	Array of StepConditionResp objects	参数解释：条件节点执行条件。

表9 JobInputResp
参数	参数类型	描述
name	String	参数解释：输入数据的名称。取值范围：不涉及。
type	String	参数解释：输入项类型。取值范围：枚举值如下： dataset：数据集 obs：OBS data_selector：数据选择
data	Object	参数解释：输入项数据。
value	Object	参数解释：输入项的值。

**表10** JobOutputResp
参数	参数类型	描述
name	String	参数解释：输出数据的名称。取值范围：不涉及。
type	String	参数解释：输出项类型。取值范围：枚举值如下： obs：OBS model：AI应用元模型
config	Map<String,Object>	参数解释：输出配置。

**表11** WorkflowErrorInfoResp
参数	参数类型	描述
error_code	String	参数解释：错误码。取值范围：不涉及。
error_message	String	参数解释：错误信息。取值范围：不涉及。

**表12** WorkflowStepExecutionPolicyResp
参数	参数类型	描述
execution_policy	String	参数解释：执行策略，取值范围：可选值如下： retry：重试 stop：停止 continue：继续运行
use_cache	Boolean	参数解释：是否使用的是缓存。取值范围： true：是缓存 false：不是缓存

**表13** WorkflowConditionExecutionResp
参数	参数类型	描述
result	String	参数解释：执行结果。取值范围：不涉及。
metric_list	Array of WorkflowMetricPairResp objects	参数解释：工作流度量信息列表。

**表14** WorkflowMetricPairResp
参数	参数类型	描述
key	String	参数解释：度量信息metric的key。取值范围：不涉及。
value	Object	参数解释：度量信息metric的值。

**表15** StepConditionResp
参数	参数类型	描述
type	String	参数解释：判断类型，例如==（等于）、!=（不等于）、>（大于）、>=（大于等于）、<（小于）、<=（小于等于）、in（包含）、or（或）。取值范围：不涉及。
left	Object	参数解释：节点执行条件为true时的分支。
right	Object	参数解释：节点执行条件为false时的分支。

**表16** WorkflowSubgraphResp
参数	参数类型	描述
name	String	参数解释：子图名称。取值范围：不涉及。
steps	Array of strings	参数解释：子图step成员。

**表17** DataRequirementResp
参数	参数类型	描述
name	String	参数解释：训练数据的名称。取值范围：不涉及。
type	String	参数解释：数据来源类型。取值范围：枚举值如下： dataset：数据集 obs：OBS swr：SWR model_list：AI应用列表 label_task：标注任务 service：在线服务
conditions	Array of ConstraintResp objects	参数解释：数据约束条件。
value	Map<String,Object>	参数解释：数据的值。
used_steps	Array of strings	参数解释：使用了这条数据的工作流节点。
delay	Boolean	参数解释：延时参数标记。取值范围： true：延时 false：不延时

**表18** ConstraintResp
参数	参数类型	描述
attribute	String	参数解释：条件属性，参数的某个字段值。取值范围：不涉及。
operator	String	参数解释：操作。取值范围：不涉及。
value	Object	参数解释：取值。

**表19** WorkflowParameterResp
参数	参数类型	描述
name	String	参数解释：Workflow工作流配置参数的名称。取值范围：不涉及。
type	String	参数解释：参数的类型。取值范围：枚举值如下: str：字符串 int：整型 bool：布尔类型 float：浮点型
description	String	参数解释：Workflow工作流配置参数的描述。取值范围：不涉及。
example	Object	参数解释：Workflow工作流配置参数的样例。
delay	Boolean	参数解释：是否为延迟输入的参数。取值范围： true：是 false：否
default	Object	参数解释：配置参数的默认值。
value	Object	参数解释：参数值。
enum	Array of objects	参数解释：Workflow工作流配置参数的枚举项。
used_steps	Array of strings	参数解释：使用这个参数的工作流节点。
format	String	参数解释：数据格式。取值范围：不涉及。
constraint	Map<String,Object>	参数解释：限制条件。

**表20** WorkflowDagPoliciesResp
参数	参数类型	描述
use_cache	Boolean	参数解释：是否使用缓存。取值范围： true：使用缓存 false：不使用缓存

请求示例

停止工作流

POST https://{endpoint}/v2/{project_id}/workflows/{workflow_id}/executions/4dd2a2f5-bde2-45dd-af6b-5e5d570118d1/actions

{
  "action_name" : "stop"
}

响应示例

状态码：201

{
  "created_at" : "2022-08-25T17:01:52.490825+08:00",
  "name" : "execution-005",
  "execution_id" : "4dd2a2f5-bde2-45dd-af6b-5e5d570118d1",
  "description" : "",
  "status" : "running",
  "workspace_id" : "0",
  "workflow_id" : "bd0ac50e-69b1-4d20-ae38-abb221084fc6",
  "workflow_name" : "workflow-service-infer",
  "steps_execution" : [ {
    "created_at" : "2022-08-25T17:01:52.500034+08:00",
    "uuid" : "54979c30-cc48-4eaa-8b0f-b6eb6e000bb5",
    "step_name" : "service_step",
    "step_title" : "service_step",
    "status" : "wait_inputs",
    "duration" : 1,
    "events" : [ "2022-08-25 17:01:53 change status from init to wait_inputs" ],
    "policy" : { }
  } ],
  "duration" : 1,
  "events" : [ "2022-08-25 17:01:53 step service_step change status from init to wait_inputs" ],
  "data_requirements" : [ {
    "name" : "si_placeholder1",
    "type" : "model_list",
    "delay" : true,
    "conditions" : [ {
      "attribute" : "model_name",
      "operator" : "equal",
      "value" : "model_test444444222222"
    } ],
    "used_steps" : [ "service_step" ]
  }, {
    "name" : "si_placeholder2",
    "type" : "model_list",
    "delay" : true,
    "conditions" : [ {
      "attribute" : "model_name",
      "operator" : "equal",
      "value" : "model_test444444222222"
    }, {
      "attribute" : "envs",
      "operator" : "equal",
      "value" : {
        "infer_address" : "$ref/consumptions/service_step/service_output/access_address"
      }
    } ],
    "used_steps" : [ "service_step2" ]
  } ],
  "parameters" : [ {
    "name" : "schedule_KZ27",
    "type" : "int",
    "format" : "schedule",
    "description" : "Set how long the deployed service will stop in hours, where -1 means the service will always run",
    "delay" : true,
    "used_steps" : [ "service_step", "service_step2" ]
  }, {
    "name" : "placeholder_name",
    "type" : "str",
    "value" : "model_test4444",
    "used_steps" : [ "service_step", "service_step2" ]
  } ],
  "policies" : { }
}