更新时间:2025-07-28 GMT+08:00
分享

查询Workflow Execution

功能介绍

查询Workflow Execution接口用于查看工作流实例的执行情况。

该接口适用于以下场景:当用户需要监控和管理已启动的工作流执行实例时,可以通过此接口查询执行状态、开始时间、结束时间、执行结果等信息。使用该接口的前提条件是用户具有查看权限。查询结果将根据用户提供的过滤条件返回。若用户无权限操作或输入参数不合法,接口将返回相应的错误信息。

接口约束

调试

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

URI

GET /v2/{project_id}/workflows/{workflow_id}/executions/{execution_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:用户项目ID。获取方法请参见获取项目ID和名称

约束限制:1 - 64字符,字母、数字和中划线。

取值范围:不涉及。

默认取值:不涉及。

workflow_id

String

参数解释:工作流的ID。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

execution_id

String

参数解释:工作流执行ID,获取方法请参见查询工作流执行记录列表。。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

created_at

String

参数解释:创建时间。

取值范围:不涉及。

name

String

参数解释:执行记录名称。

取值范围:不涉及。

execution_id

String

参数解释:工作流执行ID。获取方法请参见查询工作流执行记录列表。。

取值范围:不涉及。

description

String

参数解释:执行记录描述。

取值范围:不涉及。

status

String

参数解释:执行记录状态。

取值范围:不涉及。

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

参数解释:执行记录使用到的执行策略。

表3 StepExecutionResp

参数

参数类型

描述

step_name

String

参数解释:节点的名称,在一个DAG中唯一。

取值范围:不涉及。

uuid

String

参数解释:唯一标识uuid。创建节点执行时,后台自动生成。

取值范围:不涉及。

created_at

String

参数解释:Execution执行的创建时间。

取值范围:不涉及。

duration

Integer

参数解释:Execution执行的运行时长。

取值范围:不涉及。

type

String

参数解释:节点的类型。

取值范围:不涉及。

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,Object>

参数解释:节点的属性。

events

Array of strings

参数解释:节点发生的事件。

error_info

WorkflowErrorInfoResp object

参数解释:Execution执行的错误信息。

policy

WorkflowStepExecutionPolicyResp object

参数解释:节点的执行策略。

conditions_execution

WorkflowConditionExecutionResp object

参数解释:条件执行。

step_title

String

参数解释:节点标题。

取值范围:不涉及。

conditions

Array of StepConditionResp objects

参数解释:条件节点执行条件。

表4 JobInputResp

参数

参数类型

描述

name

String

参数解释:输入数据的名称。

取值范围:不涉及。

type

String

参数解释:输入项类型。

取值范围:枚举值如下:

  • dataset:数据集

  • obs:OBS

  • data_selector:数据选择

data

Object

参数解释:输入项数据。

value

Object

参数解释:输入项的值。

表5 JobOutputResp

参数

参数类型

描述

name

String

参数解释:输出数据的名称。

取值范围:不涉及。

type

String

参数解释:输出项类型。

取值范围:枚举值如下:

  • obs:OBS

  • model:AI应用元模型

config

Map<String,Object>

参数解释:输出配置。

表6 WorkflowErrorInfoResp

参数

参数类型

描述

error_code

String

参数解释:错误码。

取值范围:不涉及。

error_message

String

参数解释:错误信息。

取值范围:不涉及。

表7 WorkflowStepExecutionPolicyResp

参数

参数类型

描述

execution_policy

String

参数解释:执行策略,

取值范围:可选值如下:

  • retry:重试

  • stop:停止

  • continue:继续运行

use_cache

Boolean

参数解释:是否使用的是缓存。

取值范围

  • true:是缓存

  • false:不是缓存

表8 WorkflowConditionExecutionResp

参数

参数类型

描述

result

String

参数解释:执行结果。

取值范围:不涉及。

metric_list

Array of WorkflowMetricPairResp objects

参数解释:工作流度量信息列表。

表9 WorkflowMetricPairResp

参数

参数类型

描述

key

String

参数解释:度量信息metric的key。

取值范围:不涉及。

value

Object

参数解释:度量信息metric的值。

表10 StepConditionResp

参数

参数类型

描述

type

String

参数解释:判断类型,例如==(等于)、!=(不等于)、>(大于)、>=(大于等于)、<(小于)、<=(小于等于)、in(包含)、or(或)。

取值范围:不涉及。

left

Object

参数解释:节点执行条件为true时的分支。

right

Object

参数解释:节点执行条件为false时的分支。

表11 WorkflowSubgraphResp

参数

参数类型

描述

name

String

参数解释:子图名称。

取值范围:不涉及。

steps

Array of strings

参数解释:子图step成员。

表12 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:不延时

表13 ConstraintResp

参数

参数类型

描述

attribute

String

参数解释:条件属性,参数的某个字段值。

取值范围:不涉及。

operator

String

参数解释:操作。

取值范围:不涉及。

value

Object

参数解释:取值。

表14 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>

参数解释:限制条件。

表15 WorkflowDagPoliciesResp

参数

参数类型

描述

use_cache

Boolean

参数解释:是否使用缓存。

取值范围

  • true:使用缓存

  • false:不使用缓存

请求示例

查询Workflow Execution详情

GET https://{endpoint}/v2/{project_id}/workflows/{workflow_id}/executions/fa412c98-6d94-42a2-891a-99cd1da93916

响应示例

状态码:200

Execution Information

{
  "created_at" : "2022-06-16T23:12:48.458022+08:00",
  "name" : "execution-056",
  "execution_id" : "fa412c98-6d94-42a2-891a-99cd1da93916",
  "description" : "",
  "status" : "stopped",
  "workspace_id" : "0",
  "workflow_id" : "f1642618-43eb-4ab1-a0b1-9cc584182c60",
  "workflow_name" : "workflow_model_service_no_modify_xiahou_copy",
  "steps_execution" : [ {
    "created_at" : "2022-06-16T23:12:48.466906+08:00",
    "uuid" : "5e8456bd-35ff-4cc9-9624-935c37dabe47",
    "instance_id" : "{\"model_id\":\"7d795a48-e646-43b0-b4cb-759454acaf2b\"}",
    "step_name" : "model_step",
    "step_title" : "model release",
    "status" : "completed",
    "duration" : 17,
    "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" : "7d795a48-e646-43b0-b4cb-759454acaf2b"
      }
    } ],
    "properties" : {
      "model_name" : "lh-xh",
      "model_type" : "TensorFlow"
    },
    "events" : [ "2022-06-16 23:12:49 change status from init to creating", "2022-06-16 23:12:51 change status from creating to created", "2022-06-16 23:12:51 change status from created to running", "2022-06-16 23:13:05 change status from running to completed" ],
    "policy" : { }
  }, {
    "created_at" : "2022-06-16T23:13:05.620354+08:00",
    "uuid" : "9b452016-cc7b-4bfe-snt9-f9d53dcb4cc1",
    "step_name" : "service_step",
    "step_title" : "service install",
    "status" : "stopped",
    "duration" : 1,
    "events" : [ "2022-06-16 23:13:06 change status from init to wait_inputs", "2022-06-16 23:16:13 change status from wait_inputs to stopped" ],
    "policy" : { }
  } ],
  "duration" : 204,
  "events" : [ "2022-06-16 23:12:49 step model_step change status from init to creating", "2022-06-16 23:12:51 step model_step change status from creating to created", "2022-06-16 23:12:51 step model_step change status from created to running", "2022-06-16 23:13:05 step model_step change status from running to completed", "2022-06-16 23:13:06 step service_step change status from init to wait_inputs", "2022-06-16 23:16:13 step service_step change status from wait_inputs to stopped" ],
  "data_requirements" : [ {
    "name" : "model_input",
    "type" : "obs",
    "conditions" : [ {
      "attribute" : "object_type",
      "operator" : "equal",
      "value" : "directory"
    } ],
    "value" : {
      "object_type" : [ "DIRECTORY" ],
      "obs_url" : "/test-crq/train_output/"
    },
    "used_steps" : [ "model_step" ]
  }, {
    "name" : "service_model",
    "type" : "model_list",
    "delay" : true,
    "conditions" : [ {
      "attribute" : "model_name",
      "operator" : "equal",
      "value" : "lh-xh"
    } ],
    "used_steps" : [ "service_step" ]
  } ],
  "parameters" : [ {
    "name" : "schedule_d5sm",
    "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" ]
  } ],
  "policies" : { }
}

状态码

状态码

描述

200

Execution Information

错误码

请参见错误码

相关文档