管理Workflow StepExecution
功能介绍
本接口支持对Workflow StepExecution进行重试、停止和继续操作。
接口约束
无
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/workflows/{workflow_id}/executions/{execution_id}/step-executions/{step_execution_id}/actions
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释:用户项目ID。获取方法请参见获取项目ID和名称。 约束限制:1 - 64字符,字母、数字和中划线。 取值范围:不涉及。 默认取值:不涉及。 |
workflow_id |
是 |
String |
参数解释:工作流的ID。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
execution_id |
是 |
String |
参数解释:工作流执行ID,获取方法请参见查询工作流执行记录列表。。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
step_execution_id |
是 |
String |
工作流的一次执行中一个节点的执行ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
action_name |
是 |
String |
操作名称,枚举如下:
|
data_requirements |
否 |
Array of DataRequirement objects |
工作流需要的数据。 |
parameters |
否 |
Array of WorkflowParameter objects |
参数。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
参数解释:训练数据的名称。 约束限制:长度为1-64位,仅包含英文、数字、下划线(_)和中划线(-),并且以英文开头的名称。 取值范围:不涉及。 默认取值:不涉及。 |
type |
是 |
String |
参数解释:数据来源类型。 约束限制:不涉及。 取值范围:枚举值如下:
默认取值:不涉及。 |
conditions |
否 |
Array of Constraint objects |
参数解释:数据约束条件。 约束限制:不涉及。 |
value |
否 |
Map<String,Object> |
参数解释:数据的值。 约束限制:不涉及。 |
used_steps |
否 |
Array of strings |
参数解释:使用了这条数据的工作流节点。 约束限制:不涉及。 |
delay |
否 |
Boolean |
参数解释:延时参数标记。 约束限制:不涉及。 取值范围:
默认取值:不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
attribute |
否 |
String |
参数解释:条件属性,参数的某个字段值。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
operator |
否 |
String |
参数解释:操作。 约束限制:当前只支持equal操作。 取值范围:不涉及。 默认取值:不涉及。 |
value |
否 |
Object |
参数解释:取值。 约束限制:不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
参数解释:Workflow工作流配置参数的名称。 约束限制:长度为1-64位,仅包含英文、数字、下划线(_)和中划线(-),并且以英文开头的名称。 取值范围:不涉及。 默认取值:不涉及。 |
type |
否 |
String |
参数解释:参数的类型。 约束限制:不涉及。 取值范围:枚举值如下:
默认取值:不涉及。 |
description |
否 |
String |
参数解释:Workflow工作流配置参数的描述。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
example |
否 |
Object |
参数解释:Workflow工作流配置参数的样例。 约束限制:不涉及。 |
delay |
否 |
Boolean |
参数解释:是否为延迟输入的参数。 约束限制:不涉及。 取值范围:
默认取值:默认为否。 |
default |
否 |
Object |
参数解释:配置参数的默认值。 约束限制:不涉及。 |
value |
否 |
Object |
参数解释:参数值。 约束限制:不涉及。 |
enum |
否 |
Array of objects |
参数解释:Workflow工作流配置参数的枚举项。 约束限制:不涉及。 |
used_steps |
否 |
Array of strings |
参数解释:使用这个参数的工作流节点。 约束限制:不涉及。 |
format |
否 |
String |
参数解释:数据格式。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
constraint |
否 |
Map<String,Object> |
参数解释:限制条件。 约束限制:不涉及。 |
响应参数
状态码:201
参数 |
参数类型 |
描述 |
---|---|---|
step_name |
String |
参数解释:节点的名称,在一个DAG中唯一。 约束限制:长度为1到64位,只包含中英文,数字,空格,下划线(_)和中划线(-),并且以中英文开头。 取值范围:不涉及。 默认取值:不涉及。 |
uuid |
String |
参数解释:唯一标识uuid。创建节点执行时,后台自动生成。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
created_at |
String |
参数解释:Execution执行的创建时间。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
duration |
Integer |
参数解释:Execution执行的运行时长。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
type |
String |
参数解释:节点的类型。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
instance_id |
String |
参数解释:实例ID。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
status |
String |
参数解释:节点的状态。 约束限制:不涉及。 取值范围:枚举值如下:
默认取值:不涉及。 |
inputs |
Array of JobInput objects |
参数解释:节点的输入项。 约束限制:不涉及。 |
outputs |
Array of JobOutput objects |
参数解释:节点的输出项。 约束限制:不涉及。 |
step_uuid |
String |
参数解释:节点的UUID,唯一性标识。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
properties |
Map<String,Object> |
参数解释:节点的属性。 约束限制:不涉及。 |
events |
Array of strings |
参数解释:节点发生的事件。 约束限制:不涉及。 |
error_info |
WorkflowErrorInfo object |
参数解释:Execution执行的错误信息。 约束限制:不涉及。 |
policy |
WorkflowStepExecutionPolicy object |
参数解释:节点的执行策略。 约束限制:不涉及。 |
conditions_execution |
WorkflowConditionExecution object |
参数解释:条件执行。 约束限制:不涉及。 |
step_title |
String |
参数解释:节点标题。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
conditions |
Array of StepCondition objects |
参数解释:条件节点执行条件。 约束限制:不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释:输入数据的名称。 约束限制:长度支持1到64位,只包含英文、数字、下划线(_)和中划线(-)的字符。 取值范围:不涉及。 默认取值:不涉及。 |
type |
String |
参数解释:输入项类型。 约束限制:不涉及。 取值范围:枚举值如下:
默认取值:不涉及。 |
data |
Object |
参数解释:输入项数据。 约束限制:不涉及。 |
value |
Object |
参数解释:输入项的值。 约束限制:不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释:输出数据的名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
type |
String |
参数解释:输出项类型。 约束限制:不涉及。 取值范围:枚举值如下:
默认取值:不涉及。 |
config |
Map<String,Object> |
参数解释:输出配置。 约束限制:不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释:错误码。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
error_message |
String |
参数解释:错误信息。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
execution_policy |
String |
参数解释:执行策略, 约束限制:不涉及。 取值范围:可选值如下:
默认取值:不涉及。 |
use_cache |
Boolean |
参数解释:是否使用的是缓存。 约束限制:不涉及。 取值范围:
默认取值:不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
result |
String |
参数解释:执行结果。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
metric_list |
Array of WorkflowMetricPair objects |
参数解释:工作流度量信息列表。 约束限制:不涉及。 |
请求示例
停止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
OK
{ "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" : { } }
状态码
状态码 |
描述 |
---|---|
201 |
OK |
错误码
请参见错误码。