文档首页/ 医疗智能体 EIHealth/ API参考/ API（医疗智能体平台）/ Nextflow接口/ Nextflow作业管理/ 查询nextflow作业列表
更新时间：2024-05-09 GMT+08:00
查看PDF
分享

查询nextflow作业列表

功能介绍

查询nextflow作业列表

调试

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

URI

GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/jobs

表1 路径参数

参数

是否必选

参数类型

描述

eihealth_project_id

是

String

平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。

最小长度：1

最大长度：128

project_id

是

String

华为云项目ID，您可以从获取项目ID中获取。

最小长度：1

最大长度：128
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

限制量，单次查询总量，必须由数字组成，默认为100，取值范围[1,1000]

最小值：1

最大值：1000

缺省值：100

offset

否

Integer

偏移量，查询起始偏移，必须由数字组成，默认为0，取值范围[0,100000000]

最小值：0

最大值：100000000

缺省值：0

sort_dir

否

String

排序规则 目前默认时间降序

缺省值：DESC

sort_key

否

String

排序规则 目前默认时间降序，支持根据status

job_name

否

String

作业名称

最小长度：1

最大长度：128

labels

否

Array

标签列表

最小长度：1

最大长度：32

数组长度：0 - 5

status

否

String

作业运行状态 取值（SUBMITTED|RUNNING|COMPLETED|FAILED|CANCELLED|UNKNOWN）

workflow_name

否

String

workflow名称

最小长度：1

最大长度：128

user_name

否

String

作业创建者

最小长度：1

最大长度：128

create_start_time

否

Long

最小创建时间

最小值：1000000000000

最大值：9999999999999

create_end_time

否

Long

最大创建时间

最小值：1000000000000

最大值：9999999999999

finish_start_time

否

Long

最小结束时间

最小值：1000000000000

最大值：9999999999999

finish_end_time

否

Long

最大结束时间

最小值：1000000000000

最大值：9999999999999

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：1

最大长度：32768

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

jobs

Array of NextflowJobListDto objects

作业列表

count

Integer

作业总数
表5 NextflowJobListDto

参数

参数类型

描述

id

String

作业id

name

String

作业的名称，取值范围：[1,63]，允许大小写字母、数字、以及特殊字符中划线(-)

description

String

作业的描述,取值范围：输入字符最大长度为255

labels

Array of strings

作业标签

status

String

作业状态

has_ignore_failed_tasks

Boolean

是否包含已被忽略的失败tasks

create_time

String

作业创建时间

finish_time

String

作业结束时间

failed_message

String

失败提示，当作业执行失败时会返回

failed_reason

String

失败原因，当作业执行失败时会返回

user_name

String

创建任务的用户名称

workflow_name

String

流程名称

workflow_id

String

流程id

请求示例

无

响应示例

状态码： 200

OK

{
  "count" : 1,
  "jobs" : [ {
    "id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488",
    "name" : "demo-job",
    "description" : "description",
    "status" : "COMPLETED",
    "has_ignore_failed_tasks" : false,
    "create_time" : "2021-01-30T02:34:36Z",
    "finish_time" : "2021-01-30T02:53:26Z",
    "user_name" : "demo-user",
    "workflow_name" : "demo-workflow",
    "workflow_id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488"
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： Nextflow作业管理

相关文档