云服务器内容精选

  • 简介 Nextflow是专门针对生物信息流程搭建而开发的一种框架语言,它能够很好的管理生信流程,并且将其与Conda、Docker、Singularity结合起来使用,可以很好的将流程在不同平台之间进行迁移,并且能够保证结果的可重复性。Nextflow最大的优点是它是基于数据流的程序模型,因此不用自己去写复杂的并行化的程序,只需要关注“数据流”即可。流程中的每个process可以通过配置文件快速的定制并行执行的样本数目,大大节约了生信人员搭建组学分析流程的时间。 医疗智能体 EIHealth )平台集成了Nextflow框架,支持用户直接在医疗智能体(EIHealth)平台安装Nextflow。 父主题: Nextflow
  • 响应示例 状态码: 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 表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
  • 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
  • 命令示例 获取task列表 health nextflow get task -j "7991e0b4-bffe-4166-ac2e-45a261592dcc" { "tasks": [ { "task_id": "1", "process": "readfile", "hash": "f2/a0f16c", "status": "RUNNING", "container": "swr.xxx/eihealth-0659ea54-5ae6-4e9d-b014-a2b041a26f62/admet:2.0.0.1659942728536", "pod_name": "nf-f2a0f16c66bbe8e28824e8ccabbddd25", "submit": "2023-03-09T08:50:37Z" } ], "count": 1 } 获取task详情 health nextflow get task 1 -j "7991e0b4-bffe-4166-ac2e-45a261592dcc" { "id": "1", "command": "\n echo /test;sleep 1000;echo \"end /test\";\n ", "status": "RUNNING", "exit": 2147483647, "work_dir": "/nextflow/__nextflow_work__/e6dcd289-dadb-48d9-b53b-e0c6c256932e/mb79e5e6-1b14-41b4-ac3b-e8fb0122d64d/f2/a0f16c66bbe8e28824e8ccabbddd25", "module": [], "container": "swr.xxx/eihealth-0659ea54-5ae6-4e9d-b014-a2b041a26f62/admet:2.0.0.1659942728536", "attempt": 1, "execution_time": { "submit": "2023-03-09T08:50:37Z", "start": "2023-03-09T08:50:40Z" }, "resource_requested": { "container": "swr.xxx/eihealth-0659ea54-5ae6-4e9d-b014-a2b041a26f62/admet:2.0.0.1659942728536", "cpus": 1 }, "resource_usage": {} } 获取task日志 health nextflow get task 1 -j "7991e0b4-bffe-4166-ac2e-45a261592dcc" -t logs { "count": 1, "logs": [ "2023-03-09T08:50:44Z /test\n" ] }
  • 响应示例 状态码: 200 OK { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "name" : "demo-workflow", "description" : "description", "labels" : [ "labelA", "labelB" ], "create_time" : "2021-01-30T02:34:36Z", "update_time" : "2021-01-30T02:53:26Z", "workflow_file" : "workflow.zip", "workflow_file_url" : "https://workflow.zip", "main_file" : "main.nf", "params_file" : "p1.yaml", "source_project_name" : "src", "source_resource_id" : "src-id", "params" : [ { "name" : "p1", "value" : "hello", "type" : "Other", "description" : "desc", "required" : true } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 id String 流程id name String 流程名称 description String 流程描述 labels Array of strings 流程标签 workflow_file String 流程的文件名 workflow_file_url String 流程的文件名下载地址 main_file String 主文件名 params_file String 用户上传时使用的参数文件名 params Array of NextflowParamsDto objects 流程参数列表 create_time String 流程的创建时间 update_time String 流程的更新时间 source_project_name String 源项目名称 source_resource_id String 源资源id 表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 参数是否必填
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/workflows/{workflow_id} 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 workflow_id 是 String 流程id 最小长度:1 最大长度:128
  • 响应示例 状态码: 200 OK { "count" : 1, "logs" : [ "Nextflow log" ], "download_url" : "https://nextflow-cn-north-4-07d79450.obs.cn-north-4.ulanqab.huawei.com/__nextflow_run__/xxx-xxx-xxx/xx-xxxx-xxxxx/DAG.png?AccessKeyId=ABCDE&Expires=1676759470&Signature=DDDDD" }
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/jobs/{job_id}/logs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 job_id 是 String 作业id 最小长度:1 最大长度:128
  • 请求示例 安装Nextflow,指定Nextflow版本为1.0.0 https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/nextflow/engines { "version" : "1.0.0" } 安装Nextflow,上传本地名为test.txt的Nextflow文件 { "total_part" : 1, "part_number" : 1, "file_name" : "test.txt", "file" : "(binary)", "multipart_id" : "0000018615613ADF4014668067FBD6A7" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限, 获取Token 接口响应消息头中X-Subject-Token的值即为Token。 最小长度:1 最大长度:32768 表3 FormData参数 参数 是否必选 参数类型 描述 file 否 File 文件流对象 part_number 否 Integer 分段序号,表示第几个文件片段 最小值:1 最大值:128 缺省值:1 total_part 否 Integer 分段总数,上传的文件总共分成了几个片段 最小值:1 最大值:128 缺省值:1 multipart_id 否 String 分段上传任务id,除了第一个片段外,后续的片段都需要标识出任务id 最小长度:1 最大长度:128 file_name 否 String 文件名称 最小长度:1 最大长度:100 version 否 String 版本号 最小长度:1 最大长度:50
  • URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/jobs/{job_id}/tasks/{task_id}/logs 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 project_id 是 String 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 job_id 是 String 作业id 最小长度:1 最大长度:128 task_id 是 String 任务id 最小长度:1 最大长度:128
  • 响应示例 状态码: 200 OK { "count" : 1, "logs" : [ "Nextflow task log" ], "download_url" : "https://nextflow-cn-north-4-07d79450.obs.cn-north-4.ulanqab.huawei.com/__nextflow_run__/xxx-xxx-xxx/xx-xxxx-xxxxx/DAG.png?AccessKeyId=ABCDE&Expires=1676759470&Signature=DDDDD" }
  • 响应示例 状态码: 200 OK { "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" }