文档首页/ 基因容器 GCS/ API参考/ API/ Workflow/ 查询workflow列表
更新时间:2022-06-15 GMT+08:00
分享

查询workflow列表

功能介绍

查询流程列表。

URI

GET /v1/workflows

表1 请求参数

参数

是否必选

参数类型

描述

name

String

指定流程名称,模糊匹配获取含有该name的流程列表。

scope

String

指定流程的scope,过滤scope为当前指定值的流程列表。如果scope为空,将返回该租户下的所有自定义流程和公共流程。支持选项为:

  • “domain”:仅当前租户可见可用。
  • “public”:流程所有租户可见可用。

offset

String

偏移量,查询起始偏移,默认为0。必须由数字组成。

limit

String

限制量,单次查询总量,和offset必须成对出现。必须由数字组成。

project_id

String

已用项目ID。如果指定,需与token中携带的值一致,如果不指定,默认返回当前项目的执行结果。

请求消息

请求示例

GET /v1/workflows HTTP/1.1 
Host:Host Server   
Content-Type:application/json

响应消息

响应参数

响应中含有多个流程结构,结构如表2所示。

响应示例

{
  "workflow": [
    {
      "id": "8a50f68a-bd2b-b223-c31a-5d2fa48cbbb7",
      "name": "gcs-2018-0816-080719",
      "description": "",
      "vendor": "gcs-user",
      "scope": "domain",
      "domain": "gcs-user",
      "domain_id": "b0148a2cb4*********77bab429e48e7",
      "project_id": "c51567523b********a81ede51894ac",
      "create_at": "2018-08-16T08:07:20Z",
      "update_at": "2018-08-16T08:07:20Z",
      "workflow_url": "https://geneworkflows-149-b0148a2cb4f347289b477bab429e48e7.192.149.46.200:443/gcs-2018-0816-080719/gcs-2018-0816-064501-1.0.yaml",
      "logo": "",
      "image": "",
      "enterprise_project_id":{"id":"0", "name":"default"}
    },
    {
      "id": "1dc19791-f34d-5403-7125-b9e32ccef95f",
      "name": "parser",
      "description": "",
      "vendor": "gcs-user",
      "scope": "domain",
      "domain": "gcs-user",
      "domain_id": "b0148a2cb4f3********bab429e48e7",
      "project_id": "c51567523b********a81ede51894ac",
      "create_at": "2018-08-13T02:44:22Z",
      "update_at": "2018-08-13T02:44:22Z",
      "workflow_url": "https://geneworkflows-149-b0148a2cb4f347289b477bab429e48e7.192.149.46.200:443/parser/gatk4-best-practi.yaml",
      "logo": "hw-gcs-logo-southchina-b0148a2cb4f347289b477bab429e48e7:",
      "image": "",
      "enterprise_project_id":{"id":"0", "name":"default"}
    },
  ],
  "total_num": 2
}

状态码

  • 正常

    状态码如表2所示。

表2 状态码

状态码

描述

200

流程列表查询成功

相关文档