管理Workflow StepExecution - CreateWorkflowStepExecutionsActions

功能介绍

管理Workflow StepExecution接口用于对某些节点步骤进行重试、停止和继续操作。

该接口适用于以下场景：当用户需要管理特定节点的执行情况时，可以通过此接口对指定节点步骤停止、继续，对失败节点可以重试。使用该接口的前提条件是用户具有管理工作流节点步骤的权限。操作完成后，响应消息体中将包含指定步骤执行的详细信息。若步骤执行不存在或用户无权限操作，接口将返回相应的错误信息。

接口约束

无

调试

您可以在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}/step-executions/{step_execution_id}/actions

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

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
action_name	是	String	参数解释：操作名称。约束限制：不涉及。取值范围：枚举如下: retry：重试 stop：停止 continue：继续默认取值：不涉及。
data_requirements	否	Array of DataRequirement objects	参数解释：工作流需要的数据。约束限制：不涉及。
parameters	否	Array of WorkflowParameter objects	参数解释：参数。约束限制：不涉及。

表3 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：不延时默认取值：不涉及。

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

表5 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>	参数解释：限制条件。约束限制：不涉及。

响应参数

状态码：201

表6 响应Body参数
参数	参数类型	描述
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	参数解释：条件节点执行条件。

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

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

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

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

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

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

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

请求示例

停止step

POST https://{endpoint}/v2/{project_id}/workflows/{workflow_id}/executions/4dd2a2f5-bde2-45dd-af6b-5e5d570118d1/step_executions/255a1079-b00a-4c3a-8218-3458f7546b8d/actions

{
  "action_name" : "stop"
}

响应示例

状态码：201

{
  "created_at" : "2022-11-01T21:36:04.310635+08:00",
  "uuid" : "2f7ad04a-60cb-4f1c-96fd-dfc9cf96363b",
  "instance_id" : "{\"model_id\":\"6fe56a95-e7f1-4388-b207-c80684af0cb8\"}",
  "step_name" : "model_step",
  "step_title" : "model release",
  "status" : "completed",
  "duration" : 15,
  "inputs" : [ {
    "name" : "model_input",
    "type" : "obs",
    "data" : "$ref/data_requirements/model_input",
    "value" : {
      "object_type" : [ "DIRECTORY" ],
      "obs_url" : "/test-crq/train_output/"
    }
  } ],
  "outputs" : [ {
    "name" : "model_output",
    "type" : "model",
    "config" : {
      "model_id" : "6fe56a95-e7f1-4388-b207-c80684af0cb8"
    }
  } ],
  "properties" : {
    "model_name" : "lh-xh",
    "model_type" : "TensorFlow"
  },
  "events" : [ "2022-11-01 21:36:05 change status from init to creating", "2022-11-01 21:36:09 change status from creating to created", "2022-11-01 21:36:09 change status from created to running", "2022-11-01 21:36:19 change status from running to completed" ],
  "policy" : { }
}