获取Workflow工作流列表 - ListWorkflows

功能介绍

获取Workflow工作流列表接口用于展示已创建的工作流列表。该接口适用于以下场景：当用户需要管理、监控或操作工作流时，可通过此接口查看所有可用的工作流。使用该接口的前提条件是用户已通过身份验证并具有访问权限，且系统中已存在至少一个工作流。调用该接口后，将返回所有工作流的列表，每个工作流包含其唯一标识、名称、状态等基本信息。若用户无权限访问或系统中不存在工作流，接口将返回相应的错误信息或空列表。

接口约束

无

调试

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

授权信息

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

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

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

URI

GET /v2/{project_id}/workflows

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

表2 Query参数
参数	是否必选	参数类型	描述
name	否	String	参数解释：工作流名称。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
description	否	String	参数解释：工作流描述信息。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
status	否	String	参数解释：工作流状态。约束限制：不涉及。取值范围：枚举值： abnormal：异常 never_executed：未运行 init：初始化 running：运行中 completed：运行成功 stopped：已停止默认取值：不涉及。
labels	否	String	参数解释：工作流标签。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
template_id	否	String	参数解释：工作流模板ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
limit	否	String	参数解释：分页参数limit，表示单次查询的条目数上限。假如要查询20~29条记录，offset为20，limit为10。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
offset	否	String	参数解释：分页参数offset，表示单次查询的条目偏移数量。假如要查询20~29条记录，offset为20，limit为10。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
sort_by	否	String	参数解释：排序依据字段，例如sort_by=create_time，则表示以条目的创建时间进行排序。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
search_type	否	String	参数解释：过滤方式。约束限制：具体过滤的字段，由各个接口额外定义参数。例如Workflow支持按照名称（name）进行过滤，则相应的过滤字段为name。name=workflow&search_type=contain表示查询名称中含有Workflow字样的所有工作流。取值范围：可选值如下： equal表示精确匹配。 contain表示模糊匹配。默认取值：不涉及。

请求参数

无

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
total	Integer	参数解释：查询到当前用户名下的所有Workflow总数。取值范围：不涉及。
count	Integer	参数解释：查询到当前用户名下的所有符合查询条件的Workflow总数。取值范围：不涉及。
items	Array of WorkflowResp objects	参数解释：查询到当前用户名下的所有符合查询条件的Workflow详情。

表4 WorkflowResp
参数	参数类型	描述
name	String	参数解释：Workflow工作流名称。取值范围：不涉及。
workflow_id	String	参数解释：Workflow工作流ID。创建工作流时后台自动生成。取值范围：不涉及。
created_at	String	参数解释：Workflow工作流的创建时间。取值范围：不涉及。
description	String	参数解释：Workflow工作流的描述信息。取值范围：不涉及。
steps	Array of WorkflowStepResp objects	参数解释：Workflow工作流包含的步骤定义。
user_name	String	参数解释：创建Workflow工作流的用户名。取值范围：不涉及。
workspace_id	String	参数解释：工作空间ID。获取方法请参见查询工作空间列表。取值范围：不涉及。
data_requirements	Array of DataRequirementResp objects	参数解释：Workflow需要的数据。
data	Array of DataResp objects	参数解释：Workflow包含的数据。
parameters	Array of WorkflowParameterResp objects	参数解释：Workflow包含的参数。
source_workflow_id	String	参数解释：从指定Workflow工作流进行复制。通过复制来创建Workflow时必填。取值范围：不涉及。
gallery_subscription	WorkflowGallerySubscriptionResp object	参数解释：来自市场订阅的Workflow。
latest_execution	ExecutionBriefResp object	参数解释：最后一次执行工作流的概要信息。
run_count	Integer	参数解释：工作流的已运行次数。取值范围：不涉及。
param_ready	Boolean	参数解释：当前工作流的必选参数是否都已填完。取值范围： true：已填完 false：未填完
source	String	参数解释：工作流来源。取值范围：可选值为： ai_gallery：表示工作流是从AI Gallery导入的
storages	Array of WorkflowStorageResp objects	参数解释：Workflow包含的统一存储定义。
labels	Array of strings	参数解释：为Workflow工作流设置的标签。
assets	Array of WorkflowAssetResp objects	参数解释：工作流绑定的资产。
sub_graphs	Array of WorkflowSubgraphResp objects	参数解释：工作流包含的子图。
extend	Map<String,Object>	参数解释：计费工作流使用的拓展字段。
policy	WorkflowPolicyResp object	参数解释：工作流部分运行策略。
with_subscription	Boolean	参数解释：工作流SMN消息订阅开关。取值范围： true：打开 false：关闭
smn_switch	Boolean	参数解释：SMN开关。取值范围： true：打开 false：关闭
subscription_id	String	参数解释：SMN消息订阅ID。取值范围：不涉及。
exeml_template_id	String	参数解释：自动学习模板ID。取值范围：不涉及。
last_modified_at	String	参数解释：最近一次修改的时间。取值范围：不涉及。
package	WorkflowServicePackegeResp object	参数解释：计费工作流订阅包信息。

表5 WorkflowStepResp
参数	参数类型	描述
name	String	参数解释：Workflow工作流节点的名称，在一个DAG中唯一。取值范围：不涉及。
type	String	参数解释：节点的类型。取值范围：枚举值如下: job：训练 labeling：标注 release_dataset：数据集发布 model：模型发布 service：服务部署 mrs_job：MRS作业 dataset_import：数据集导入 create_dataset：创建数据集
inputs	Array of JobInputResp objects	参数解释：节点的输入项。
outputs	Array of JobOutputResp objects	参数解释：节点的输出项。
created_at	String	参数解释：节点的创建时间。取值范围：不涉及。
title	String	参数解释：工作流节点标题。取值范围：不涉及。
description	String	参数解释：节点的描述信息。取值范围：不涉及。
properties	Map<String,Object>	参数解释：节点属性。
depend_steps	Array of strings	参数解释：运行依赖的前置节点。
conditions	Array of StepConditionResp objects	参数解释：节点执行条件。
if_then_steps	Array of strings	参数解释：条件节点分支。
else_then_steps	Array of strings	参数解释：条件节点另一分支。
policy	WorkflowStepPolicyResp object	参数解释：节点执行策略。

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

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

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

表9 WorkflowStepPolicyResp
参数	参数类型	描述
poll_interval_seconds	String	参数解释：节点执行间隔。取值范围：不涉及。
max_execution_minutes	String	参数解释：最大执行时间。取值范围：不涉及。

**表10** 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：不延时

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

**表12** DataResp
参数	参数类型	描述
name	String	参数解释：训练数据的名称。取值范围：不涉及。
type	String	参数解释：数据来源的类型。取值范围：枚举值如下： dataset：数据集 obs：OBS swr：SWR model：模型 label_task：标注任务 service：在线服务 image：镜像
value	Map<String,Object>	参数解释：数据的值。
used_steps	Array of strings	参数解释：使用数据的节点。

**表13** 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>	参数解释：限制条件。

**表14** WorkflowGallerySubscriptionResp
参数	参数类型	描述
content_id	String	参数解释：资产ID。取值范围：不涉及。
version_id	String	参数解释：版本ID。取值范围：不涉及。
expired_at	String	参数解释：超期时间。取值范围：不涉及。

**表15** ExecutionBriefResp
参数	参数类型	描述
execution_id	String	参数解释：工作流执行ID，获取方法请参见查询工作流执行记录列表。取值范围：不涉及。
created_at	String	参数解释：工作流执行的创建时间。取值范围：不涉及。
status	String	参数解释：工作流状态。取值范围：枚举值： abnormal：异常 init：初始化 running：运行中 completed：运行成功 stopped：已停止
running_steps	Array of strings	参数解释：运行的节点。
current_steps	Array of strings	参数解释：当前节点。
duration	Long	参数解释：运行时长。取值范围：不涉及。

**表16** WorkflowStorageResp
参数	参数类型	描述
name	String	参数解释：工作流存储的名称。取值范围：不涉及。
type	String	参数解释：工作流存储的类型，当前只支持obs。取值范围：不涉及。
path	String	参数解释：统一存储的根路径，当前只支持OBS路径。取值范围：不涉及。

**表17** WorkflowAssetResp
参数	参数类型	描述
name	String	参数解释：资产名称。取值范围：不涉及。
type	String	参数解释：资产类型。取值范围：枚举如下: algorithm：算法 algorithm2：新算法 model：模型算法
content_id	String	参数解释：资产ID，可在AI Gallery中获取。取值范围：不涉及。
subscription_id	String	参数解释：订阅ID，可在AI Gallery中获取。取值范围：不涉及。
expired_at	String	参数解释：超期时间。取值范围：不涉及。

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

**表19** WorkflowPolicyResp
参数	参数类型	描述
use_scene	String	参数解释：使用场景。取值范围：不涉及。
scene_id	String	参数解释：场景ID。取值范围：不涉及。
scenes	Array of SceneResp objects	参数解释：场景。

**表20** SceneResp
参数	参数类型	描述
id	String	参数解释：场景ID。取值范围：不涉及。
name	String	参数解释：场景名称。取值范围：不涉及。
steps	Array of strings	参数解释：节点列表。

**表21** WorkflowServicePackegeResp
参数	参数类型	描述
package_id	String	参数解释：资源包的UUID。取值范围：不涉及。
status	String	参数解释：资源包状态。取值范围：枚举值如下： available：可用的 exceed：超出配额。 unauthorised：未被授权 creating：创建中 waiting：等待 restricted：已被限制 failed：失败 abnormal：异常 unsubscription：取消订阅
pool_id	String	参数解释：资源池ID。取值范围：不涉及。
service_id	String	参数解释：服务ID。取值范围：不涉及。
workflow_id	String	参数解释：Workflow工作流ID。取值范围：不涉及。
order	WorkflowPoolOrderResp object	参数解释：订阅信息。
consume_limit	Long	参数解释：订阅限制。取值范围：不涉及。
current_consume	Long	参数解释：当前订阅。取值范围：不涉及。
current_date	String	参数解释：当前时间。取值范围：不涉及。
limit_enable	Boolean	参数解释：限制标记。取值范围： true：限制 false：不限制
created_at	String	参数解释：创建时间。取值范围：不涉及。

**表22** WorkflowPoolOrderResp
参数	参数类型	描述
id	String	参数解释：订阅ID。取值范围：不涉及。
sku	SkuInfoResp object	参数解释：订阅计费信息。
sku_count	String	参数解释：订阅计数。取值范围：不涉及。

**表23** SkuInfoResp
参数	参数类型	描述
code	String	参数解释：计费码。取值范围：不涉及。
period	String	参数解释：计费时期。取值范围：不涉及。
queries_limit	Long	参数解释：查询次数。取值范围：不涉及。
price	Float	参数解释：价格。取值范围：不涉及。

请求示例

GET https://{endpoint}/v2/{project_id}/workflows

响应示例

状态码：200

{
  "total" : 1,
  "count" : 1,
  "items" : [ {
    "created_at" : "2022-09-09T11:28:29.639658+08:00",
    "workflow_id" : "6b596c75-fe1f-440b-be83-fe5e240133c4",
    "name" : "graph-test-has-condition-step",
    "description" : "",
    "user_name" : "zuoping",
    "workspace_id" : "0",
    "labels" : [ "subgraph" ],
    "data" : [ {
      "name" : "a2ff296da618452daa8243399f06db8e",
      "type" : "obs",
      "value" : {
        "obs_url" : "/test-lh/test-metrics/"
      },
      "used_steps" : [ "training_job1" ]
    }, {
      "name" : "f78e46676a454ccdacb9907f589f8d67",
      "type" : "obs",
      "value" : {
        "obs_url" : "/test-lh/test-metrics/"
      },
      "used_steps" : [ "training_job2" ]
    }, {
      "name" : "dee65054c96b4bf3b7ac98c0709f9ae0",
      "type" : "obs",
      "value" : {
        "obs_url" : "/test-lh/test-metrics/"
      },
      "used_steps" : [ "training_job3" ]
    } ],
    "parameters" : [ {
      "name" : "is_true",
      "type" : "bool",
      "delay" : true,
      "value" : true,
      "used_steps" : [ "condition_step_test" ]
    }, {
      "name" : "train_spec",
      "type" : "str",
      "format" : "flavor",
      "description" : "training specification",
      "default" : "modelarts.vm.cpu.8u",
      "used_steps" : [ "training_job1", "training_job2", "training_job3" ]
    }, {
      "name" : "service_config1",
      "type" : "str",
      "default" : "/test-lh/test-metrics/metrics.json",
      "used_steps" : [ "training_job1" ]
    }, {
      "name" : "service_config2",
      "type" : "str",
      "default" : "/test-lh/test-metrics/metrics.json",
      "used_steps" : [ "training_job2" ]
    }, {
      "name" : "service_config3",
      "type" : "str",
      "default" : "/test-lh/test-metrics/metrics.json",
      "used_steps" : [ "training_job3" ]
    } ],
    "sub_graphs" : [ {
      "name" : "stage_A",
      "steps" : [ "training_job1", "training_job2" ]
    } ],
    "policy" : { },
    "last_modified_at" : "2022-10-28T16:49:13.056726+08:00",
    "source_workflow_id" : "05427e9d-42ac-4816-bd45-360c1bfd780b",
    "latest_execution" : {
      "execution_id" : "43e317e2-34b0-4348-9c1b-08d3083512e1",
      "created_at" : "2022-10-28T16:49:03.894771+08:00",
      "status" : "completed",
      "duration" : 209
    },
    "run_count" : 2,
    "param_ready" : true
  } ]
}