获取Nextflow作业详情

功能介绍

获取Nextflow作业详情

调试

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

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
eihealth_project_id	是	String	平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。最小长度：1 最大长度：128
job_id	是	String	作业id 最小长度：1 最大长度：128
project_id	是	String	华为云项目ID，您可以从获取项目ID中获取。最小长度：1 最大长度：128

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。最小长度：1 最大长度：32768

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
id	String	作业id
name	String	作业的名称
description	String	作业的描述
labels	Array of strings	作业标签
priority	Integer	作业的优先级,取值范围[0,9]，0最低，默认数值0
status	String	作业运行状态
has_ignore_failed_tasks	Boolean	是否包含已被忽略的失败tasks
create_time	String	作业创建时间
finish_time	String	作业完成时间
failed_message	String	作业运行失败描述信息，当作业执行失败时会返回
failed_reason	String	作业运行失败原因，当作业执行失败时会返回
workflow_name	String	流程名称
workflow_id	String	流程id
command_line	String	nextflow执行命令
params	Array of NextflowParamsDto objects	作业参数列表
nextflow_parameters	Map<String,Object>	nextflow流程返回的全量参数列表
config_files	Array of strings	作业标签
config_context	String	nextflow config文件内容

表4 NextflowParamsDto
参数	参数类型	描述
name	String	参数名最小长度：1 最大长度：1024
value	String	参数值最小长度：0 最大长度：65535
type	String	参数类型,取值[Other\|File\|Directory] 最小长度：0 最大长度：20
description	String	参数描述。取值范围：[0-255] 最小长度：0 最大长度：255
required	Boolean	参数是否必填

请求示例

无

响应示例

状态码： 200

{
  "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1",
  "name" : "demo-job",
  "description" : "description",
  "labels" : [ "labelA", "labelB" ],
  "status" : "COMPLETED",
  "has_ignore_failed_tasks" : false,
  "create_time" : "2021-01-30T02:53:26Z",
  "finish_time" : "2021-01-30T02:53:26Z",
  "workflow_name" : "demo-workflow",
  "workflow_id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488",
  "command_line" : "nextflow run main.nf",
  "params" : [ {
    "name" : "p1",
    "value" : "hello",
    "type" : "Other",
    "description" : "desc",
    "required" : true
  } ],
  "config_files" : [ "nextflow.config" ],
  "config_context" : "config content"
}