概述
腾讯健康组学平台(Tencent HealthCare Omics Platform)为生命科学行业用户提供具备行业特征的一键上云整体解决方案。具备弹性云计算、任务调度及管理能力,助力大数据分析用户快速、便捷、高效的利用腾讯云资源进行组学相关数据分析。平台支持用户自定义工作流 WDL(Workflow Description Language)语言,通过工作流管理引擎 Cromwell、Nextflow 和自研任务调度引擎精细化管理和编排任务作业,有效而广泛连接不同数据分析应用场景。
本章节介绍的腾讯健康组学平台API 接口均为 [API 3.0/API 2.0等] 接口。
您可以调用 API 对腾讯健康组学平台进行操作,例如运行工作流。
腾讯健康组学平台支持的所有接口信息,请参见 API概览 。
术语表
腾讯健康组学平台 API 接口的常见术语请参见下表:
术语 | 描述 |
---|---|
环境 (Environment) | 指应用运行所需云资源的集合,包含了若干台云服务器、对象存储、文件存储等资源。为工作流和应用提供隔离的、可复现的运行条件。 |
缓存卷 (Volume) | 用于在任务运行期间缓存中间数据或持久化存储结果文件。缓存卷可以独立于计算环境存在,实现数据的复用与共享。提供了可扩展的共享文件存储服务。提供了标准的 NFS 文件系统访问协议,为多个实例提供共享的数据源,支持弹性容量和性能的扩展。 |
任务批次 (Run Group) | 一次应用/工作流执行的逻辑集合。通常,一次提交运行会创建一个任务批次,其中包含一个或多个任务(Run)。 |
任务 (Run) | 工作流或应用的单次执行实例。每个任务都有独立的生命周期状态(如运行中、成功、失败),并产生相应的日志和结果数据。 |
工作流 (Workflow) | 一系列预定义的、按特定顺序执行的计算步骤或工具的组合,用于完成一个完整的组学分析流程(如基因测序数据比对、变异检测等)。在组学平台场景下, 特指由 WDL、Nextflow 等语言编写的生信分析工作流。 |
应用 (Application) | 通常指一个封装好的、用于执行特定分析功能的单个工具或脚本。 |
表格 (Table) | 用于结构化存储和管理输入数据的实体。例如样本数据表等。 |
使用限制
API 调用频率限制为 20次/秒。
API 快速入门
您可以使用 API Explorer 工具在线调用 API。
本文以运行工作流 RunWorkflow 为例,通过 API Explorer 工具调用 API 接口的步骤如下:
1.进入 使用 API Explorer 工具页面。更多 API Explorer 工具使用信息,请参见 使用 API Explorer 。
2.调用 RunWorkflow 接口,运行指定工作流。
3.运行工作流后即可在组学平台网站对应工作项目页面查看到正在运行的工作流批次。