文档首页/ AI科学计算服务/ API参考/ API/ 应用管理/ 流程管理/ 获取流程列表 - ListWorkflow
更新时间:2025-12-23 GMT+08:00
分享

获取流程列表 - ListWorkflow

功能介绍

获取流程列表。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/workflows

表1 路径参数

参数

是否必选

参数类型

描述

eihealth_project_id

是

String

参数解释:

空间ID,您可以从获取空间ID中获取。

约束限制:

不涉及

取值范围:

仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。

默认取值:

不涉及

project_id

是

String

参数解释:

项目ID,您可以从获取项目ID中获取。

约束限制:

不涉及

取值范围:

仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

name

否

String

参数解释:

流程名称。

约束限制:

不涉及

取值范围:

仅支持字母、数字、中划线,长度为[1-56]个字符。

默认取值:

不涉及

version

否

String

参数解释:

流程版本。

约束限制:

不涉及

取值范围:

仅支持字母、数字、中划线和点,长度为[1-24]个字符。

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。

Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。

约束限制:

不涉及

取值范围:

长度为[1-32768]个字符。

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

workflows

Array of WorkflowListDto objects

参数解释:

所查询类型的流程总数。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

count

Integer

参数解释:

当前页的流程列表。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表5 WorkflowListDto

参数

参数类型

描述

id

String

参数解释:

流程ID。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

name

String

参数解释:

流程名称。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

eihealth_project_id

String

参数解释:

流程所属空间ID。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

eihealth_project_name

String

参数解释:

流程所属空间名称。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

version

String

参数解释:

流程版本。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

summary

String

参数解释:

简短描述信息。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

description

String

参数解释:

描述信息。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

labels

Array of strings

参数解释:

流程标签。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

create_time

String

参数解释:

创建流程时间。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

update_time

String

参数解释:

更新流程时间。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

user_name

String

参数解释:

创建用户名称。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

source_project_name

String

参数解释:

源项目名称。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

source_resource_id

String

参数解释:

源资源ID。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求示例

获取流程列表。

https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/workflows

响应示例

状态码:200

OK

{
  "workflows" : [ {
    "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1",
    "name" : "demo-workflow",
    "version" : "1.0.0",
    "summary" : "summary",
    "description" : "description",
    "labels" : [ "labelA", "labelB" ],
    "create_time" : "2021-01-30T02:34:36Z",
    "update_time" : "2021-01-30T02:53:26Z",
    "user_name" : "gwj-test-01"
  } ],
  "count" : 1
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

相关文档