跳转至

工作流列表

1. 接口描述

本接口用于查询多个工作流实例的概要信息。

  • 可以根据工作流ID、工作流名称、创建时间等相关信息来查询工作流的概要信息。过滤信息详细请见 过滤器ListOption。
  • 如果参数为空,返回当前用户一定数量(Limit所指定的数量,默认为20)的工作流实例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
ListOption.limit 否 Number 返回的最大工作流实例数量
ListOption.continue 否 string 返回的工作流分页起点

3. 输出参数

参数名称 必选 类型 描述
items 是 workflowInstances 工作流实例概要信息列表
metadata 是 Object 元数据

4. 示例

示例1 查看工作流列表

查看在 default 空间下所有工作流实例信息,限制返回结果最多为5项

输入示例

GET http://argon.api.mgtv.com/api/v1/namespaces/default/workflows?listOption.limit=5

输出示例

{
    metadata: {},
    items: [
        {
            argoWorkflow: {spec: {templates: [{name: "template-70c3d0f4", arguments: {}, inputs: {,…},…}],…}},
            description: "对视频源片进行HDR修复",
            displayName: "HDR片源修复",
            edges: [],
            inputs: [{id: "e17df50b", anchors: [{source: "70c3d0f4", sourceAnchor: "5f084fd1"}],…}],
            metadata: {clusterName: "default", nameSpace: "default", uid: "e6bb0549-6251-406c-a970-3af3526b1663"},
            name: "workflow-e6bb0549-6251-406c-a970-3af3526b1663",
            nodes: [{id: "70c3d0f4", label: "HDR片源制作", displayName: "HDR片源制作",…}],
            outputs: [{id: "90afdc11", anchors: [{source: "70c3d0f4", sourceAnchor: "5a77480c"}],…}],
            status: {createdAt: "2020-12-22T05:10:27Z", updatedAt: "2020-12-25T09:14:52Z"},
            version: "1.0.0"
        },
        ...
    ]
}