更新时间:2024-05-09 GMT+08:00
分享

创建nextflow作业

功能介绍

创建nextflow作业

调试

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

URI

POST /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 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:1

最大长度:32768

表3 FormData参数

参数

是否必选

参数类型

描述

name

String

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

最小长度:1

最大长度:63

description

String

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

最小长度:0

最大长度:255

labels

Array of strings

作业标签,取值范围[0,5],单个标签最大长度32字符,支持中文、字母、数字、空格、下划线和中划线,且不能以空格开头或者结尾。

最小长度:1

最大长度:32

数组长度:0 - 5

workflow_id

String

作业依赖的流程id

最小长度:0

最大长度:135

params

File

流程参数列表文件,取值范围[0, 10M]

priority

Integer

作业的优先级,取值范围[0,9],0最低,默认数值0

最小值:0

最大值:9

缺省值:0

响应参数

状态码: 201

表4 响应Body参数

参数

参数类型

描述

id

String

作业id

请求示例

创建Nextflow作业,作业名为demo-job,指定id为caadcb56-5bb6-11eb-8a0d-fa163e3ddba1的流程

https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/jobs

{
  "name" : "demo-job",
  "description" : "description",
  "labels" : "labelA,labelB",
  "workflow_id" : "caadcb56-5bb6-11eb-8a0d-fa163e3ddba1"
}

响应示例

状态码: 201

CREATED

{
  "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1"
}

状态码

状态码

描述

201

CREATED

错误码

请参见错误码

相关文档