腾讯健康组学平台数据结构

ApplicationVersion

应用版本。

被如下接口引用：DescribeRunGroups。

名称	类型	描述
Type	String	版本类型。示例值：RELEASE
ApplicationVersionId	String	版本ID。示例值：1
Name	String	发布名称。示例值：first release
Description	String	发布描述。示例值：the first released version
Entrypoint	String	入口文件。示例值：main.wdl
CreateTime	String	创建时间。示例值：2024-09-11 14:26:28
CreatorName	String	创建者名称。示例值：manager
CreatorId	String	创建者ID。示例值：827bb2144d1e422f9b525941ba1de296
GitSource	GitInfo	Git信息。示例值：{"GitHttpPath": "","GitUserName": "","GitTokenOrPassword": "","Branch": "","Tag": ""}
CosSource	CosFileInfo	COS信息。示例值：{"Bucket": "","Uri": "","Region": ""}

CVMOption

云服务器配置。

被如下接口引用：CreateEnvironment。

名称	类型	必选	描述
Zone	String	是	云服务器可用区。示例值：ap-guangzhou-6
InstanceType	String	是	云服务器实例规格。示例值：SA3.MEDIUM8

CacheInfo

缓存信息。

被如下接口引用：DescribeRuns。

名称	类型	描述
CacheClearDelay	Integer	缓存清理时间(小时)。示例值：0
CacheClearTime	Timestamp ISO8601	缓存清理计划时间。示例值：2024-06-06T17:08:33+08:00
CacheCleared	Boolean	缓存是否已被清理。示例值：true

ClusterOption

计算集群配置。

被如下接口引用：CreateEnvironment。

名称	类型	必选	描述
Zone	String	是	计算集群可用区。示例值：ap-guangzhou-6
Type	String	是	计算集群类型，取值范围： - KUBERNETES 示例值：KUBERNETES
ServiceCidr	String	否	计算集群Service CIDR，不能与VPC网段重合。示例值：192.168.0.0/20
ResourceQuota	ResourceQuota	否	资源配额。示例值：{"CPULimit": "30","MemoryLimit": "60Gi","Pods": "10"}
LimitRange	LimitRange	否	限制范围。示例值：{"MaxCPU": "5","MaxMemory": "10Gi"}
SystemNodeInstanceType	String	否	系统节点池实例规格。示例值：SA3.MEDIUM4
SystemNodeCount	Integer	否	系统节点池实例数量。示例值：2
AutoUpgradeClusterLevel	Boolean	否	纳管环境自动升配示例值：false

CosFileInfo

COS 文件信息

被如下接口引用：DescribeRunGroups。

名称	类型	必选	描述
Bucket	String	是	存储桶。示例值：bucket-12345678
Uri	String	是	COS文件地址。示例值：/path/to/file
Region	String	否	地域。示例值：ap-guangzhou

DatabaseOption

数据库配置。

被如下接口引用：CreateEnvironment。

名称	类型	必选	描述
Zone	String	是	数据库可用区。示例值：ap-guangzhou-4

Environment

组学平台环境详情。

被如下接口引用：DescribeEnvironments。

名称	类型	描述
EnvironmentId	String	环境ID。示例值：env-lljckw12
Name	String	环境名称。示例值：test name
Description	String	环境描述信息。示例值：test description
Region	String	环境地域。示例值：ap-guangzhou
Type	String	环境类型，取值范围： - KUBERNETES：Kubernetes容器集群 - HPC：HPC高性能计算集群示例值：KUBERNETES
Status	String	环境状态，取值范围： - INITIALIZING：创建中 - INITIALIZATION_ERROR：创建失败 - RUNNING：运行中 - ERROR：异常 - DELETING：正在删除 - DELETE_ERROR：删除失败示例值：RUNNING
Available	Boolean	环境是否可用。环境需要可用才能投递计算任务。示例值：True
IsDefault	Boolean	环境是否为默认环境。示例值：False
IsManaged	Boolean	环境是否为托管环境。示例值：False
Message	String	环境信息。示例值：message
ResourceIds	ResourceIds	云资源ID。示例值：{"CFSId": "cfs-iwee8gk3","CFSStorageType": "SD","CVMId": "ins-jcbptifa","EKSId": "cls-9j9zh13o","SecurityGroupId": "sg-gzsfk3r5","SubnetId": "subnet-qdkfn4xe", "TDSQLCId": "cynosdbmysql-kzwghvxj", "VPCId": "vpc-8yhq1v63"}
LastWorkflowUuid	String	上个工作流UUID。示例值：94922fcd-107e-4220-9a0f-cc3cd84a9a27
CreationTime	Timestamp ISO8601	创建时间。示例值：2022-12-14T16:14:49+08:00

EnvironmentConfig

环境配置。

被如下接口引用：CreateEnvironment。

名称	类型	必选	描述
VPCOption	VPCOption	是	私有网络配置。示例值：{"SubnetZone": "ap-guangzhou-6","VPCCIDRBlock": "10.8.0.0/16","SubnetCIDRBlock": "10.8.16.0/20"}
ClusterOption	ClusterOption	是	计算集群配置。示例值：{"Zone": "ap-guangzhou-6","Type": "KUBERNETES","ServiceCidr": "192.168.0.0/20","ResourceQuota": {"CPULimit": "30","MemoryLimit": "60Gi","Pods": "10"},"LimitRange": {"MaxCPU": "5","MaxMemory": "10Gi"}}
DatabaseOption	DatabaseOption	是	数据库配置。示例值：{"Zone": "ap-guangzhou-4"}
StorageOption	StorageOption	是	存储配置。示例值：{"StorageType": "SD","Capacity": 40960,"Zone": "ap-guangzhou-6"}
CVMOption	CVMOption	是	云服务器配置。示例值：{"Zone": "ap-guangzhou-6","InstanceType": "SA3.MEDIUM8"}
SecurityGroupOption	SecurityGroupOption	否	安全组配置。示例值：{"SecurityGroupId": "sg-cml3s14x"}

ExecutionTime

执行时间。

被如下接口引用：DescribeRunGroups, DescribeRuns。

名称	类型	描述
SubmitTime	Timestamp ISO8601	提交时间。示例值：2024-06-06T16:30:14+08:00
StartTime	Timestamp ISO8601	开始时间。示例值：2024-06-06T16:32:16+08:00
EndTime	Timestamp ISO8601	结束时间。示例值：2024-06-06T16:42:52+08:00

Filter

描述键值对过滤器，用于条件过滤查询。

若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。
若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。

被如下接口引用：DescribeEnvironments, DescribeRunGroups, DescribeRuns, DescribeTables, DescribeTablesRows, DescribeVolumes。

名称	类型	必选	描述
Name	String	是	过滤字段。示例值：Name
Values	Array of String	是	过滤字段值。示例值：["name-1","name-2"]

GitInfo

Git信息。

被如下接口引用：DescribeRunGroups, RunWorkflow。

名称	类型	必选	描述
GitHttpPath	String	是	Git地址。示例值：https://https://github.com/nf-core/taxprofiler
GitUserName	String	否	Git用户名。示例值：userName
GitTokenOrPassword	String	否	Git密码或者Token。示例值：userPassword
Branch	String	否	分支。示例值：master
Tag	String	否	标签。示例值：tag-v1.0

LimitRange

资源限制范围。

被如下接口引用：CreateEnvironment。

名称	类型	必选	描述
MaxCPU	String	否	最大CPU设置示例值：5
MaxMemory	String	否	最大内存设置（单位：Mi，Gi，Ti，M，G，T）示例值：10Gi

NFOption

Nextflow选项。

被如下接口引用：DescribeRunGroups, RetryRuns, RunApplication, RunWorkflow。

名称	类型	必选	描述
Config	String	否	Config。示例值：{"configkey":"configvalue"}
Profile	String	否	Profile。示例值：test profile
Report	Boolean	否	Report。示例值：false
Resume	Boolean	否	Resume。示例值：false
NFVersion	String	否	Nextflow引擎版本，取值范围： - 22.10.7 - 23.10.1 示例值：23.10.1
LaunchDir	String	否	启动路径。可填写指定缓存卷内的绝对路径，nextflow run 命令将在此路径执行。当WorkDir为COS路径时必填；当WorkDir为缓存卷路径时选填，不填默认使用WorkDir作为LaunchDir。示例值：/vol-8w7rfq4b/env/menv-ry46eloh/nextflow

NotificationType

通知类型

被如下接口引用：DescribeRunGroups。

名称	类型	描述
StationMessage	Boolean	腾讯健康组学平台站点信息。示例值：true
Email	Array of String	邮箱列表。示例值：["test@tencent.com"]
CurrentUserEmail	Boolean	当前用户邮箱。示例值：false

ResourceIds

云资源ID。

被如下接口引用：DescribeEnvironments。

名称	类型	描述
VPCId	String	私有网络ID。示例值：vpc-8yhq1v63
SubnetId	String	子网ID。示例值：subnet-qdkfn4xe
SecurityGroupId	String	安全组ID。示例值：sg-gzsfk3r5
TDSQLCId	String	TDSQL-C Mysql版数据库ID。示例值：cynosdbmysql-kzwghvxj
CFSId	String	文件存储ID。示例值：cfs-iwee8gk3
CFSStorageType	String	文件存储类型：取值范围： - SD：通用标准型 - HP：通用性能型 - TB：turbo标准型 - TP：turbo性能型示例值：SD
CVMId	String	云服务器ID。示例值：ins-jcbptifa
EKSId	String	弹性容器集群ID。示例值：cls-9j9zh13o
TKEId	String	TKE容器集群ID。示例值：cls-8ceobc28
TKESystemNodePoolId	String	TKE系统节点池ID。示例值：np-2ecoev9q

ResourceQuota

资源配额。

被如下接口引用：CreateEnvironment。

名称	类型	必选	描述
CPULimit	String	否	CPU Limit设置。示例值：30
MemoryLimit	String	否	内存Limit设置（单位：Mi，Gi，Ti，M，G，T）示例值：60Gi
Pods	String	否	Pods数量设置示例值：10

Run

任务。

被如下接口引用：DescribeRuns。

名称	类型	描述
RunUuid	String	任务UUID。示例值：30be0ec2-9a49-4443-8a00-f3671863e4af
ProjectId	String	项目ID。示例值：prj-shiny-mauve-fox-004230
ApplicationId	String	应用ID。示例值：app-curly-azure-fly-469732
RunGroupId	String	任务批次ID。示例值：run-happy-parchment-bulldog-708923
EnvironmentId	String	环境ID。示例值：env-ry46eloh
UserDefinedId	String	用户定义ID，单例运行为空。示例值：test sample input
TableId	String	表格ID，单例运行为空。示例值：tab-messy-violet-greyhound-915704
TableRowUuid	String	表格行UUID，单例运行为空。示例值：d889645d-67e4-4496-a54b-39f7b4aedd5c
Status	String	任务状态。示例值：EXECUTOR_ERROR
Input	String	任务输入。示例值：{"FastpDemo.in1": "cos://bucket/reads_1.fastq","FastpDemo.in2": "cos://bucket/reads_.fastq","FastpDemo.RunFastp.json": "fastp.json","FastpDemo.RunFastp.html": "fastp.html","FastpDemo.RunFastp.report_title": "fastp report"}
ExecutionTime	ExecutionTime	执行时间。示例值：{"SubmitTime": "2024-06-06T16:51:25+08:00","StartTime": "2024-06-06T16:51:56+08:00","EndTime": "2024-06-06T17:07:27+08:00"}
Cache	CacheInfo	缓存信息。示例值：{"CacheClearDelay": 0, "CacheClearTime": "2024-06-06T17:12:16+08:00", "CacheCleared": true}
ErrorMessage	String	错误信息。示例值：{"error":"ConvertFileFailed"}
CreateTime	Timestamp ISO8601	创建时间。示例值：2024-06-06T16:47:20+08:00
UpdateTime	Timestamp ISO8601	更新时间。示例值：2024-06-06T18:02:33+08:00

RunGroup

任务。

被如下接口引用：DescribeRunGroups。

名称	类型	描述
RunGroupId	String	任务批次ID。示例值：run-temperate-claret-ladybug-561748
ProjectId	String	项目ID。示例值：prj-upset-bleached-skunk-737046
ProjectName	String	项目名称。示例值：testProject
ApplicationId	String	应用ID。示例值：app-serious-bleak-mink-576863
ApplicationName	String	应用名称。示例值：testApp
ApplicationType	String	应用类型。示例值：WDL
ApplicationVersion	ApplicationVersion	应用版本。
AccessMode	String	应用访问类型： - PRIVATE 私有应用 - PUBLIC 公共应用示例值：PRIVATE
EnvironmentId	String	环境ID。示例值：env-ry46eloh
EnvironmentName	String	环境名称。示例值：testEnv
TableId	String	表格ID，单例运行为空。示例值：tab-messy-violet-greyhound-915704
Name	String	任务名称。示例值：testRun
Description	String	任务描述。示例值：a test run group
Status	String	任务状态。示例值：COMPLETE_ERROR
Type	String	任务批次类型： - WDL - NEXTFLOW 示例值：WDL
WorkDir	String	工作目录。示例值：/vol-8w7rfq4b/env/menv-ry46eloh/execution
Input	String	任务输入。示例值：{"FastpDemo.in1": "cos://bucket/reads_1.fastq","FastpDemo.in2": "cos://bucket/reads_.fastq","FastpDemo.RunFastp.json": "fastp.json","FastpDemo.RunFastp.html": "fastp.html","FastpDemo.RunFastp.report_title": "fastp report"}
InputType	String	任务输入类型： - JSON: 导入JSON - MANUAL: 手动输入 - COS: COS文件示例值：JSON
InputCosUri	String	输入COS地址。示例值：cos://bucket/input.json
InputTemplateId	String	输入模板ID。示例值：in-slim-yellow-coorgi-672677
Option	RunOption	WDL运行选项。
NFOption	NFOption	Nextflow运行选项。
Volumes	Array of VolumeInfo	使用的缓存卷。
TotalRun	Integer	任务总数量。示例值：30
RunStatusCounts	Array of RunStatusCount	各状态任务的数量。
ExecutionTime	ExecutionTime	执行时间。
ErrorMessage	String	错误信息。示例值：[{"causedBy": [{"message": "The compute backend terminated the job.", "causedBy": []}], "message": "Workflow failed"}]
Notification	RunGroupNotification	任务批次通知。
CreateTime	Timestamp ISO8601	创建时间。示例值：2024-06-06T16:30:23+08:00
UpdateTime	Timestamp ISO8601	更新时间。示例值：2024-06-06T16:45:03+08:00
Creator	String	创建者。示例值：manager
CreatorId	String	创建者ID。示例值：df8c0fbfd4b94490aed913753473ebed
ResultNotify	String	运行结果通知方式。示例值：StationMessage

RunGroupNotification

任务批次通知。

被如下接口引用：DescribeRunGroups。

名称	类型	描述
ResultNotification	RunGroupResultNotification	结果通知。
TimeoutNotification	RunGroupTimeoutNotification	超时通知。

RunGroupResultNotification

任务批次结果通知

被如下接口引用：DescribeRunGroups。

名称	类型	描述
NotificationType	NotificationType	通知类型。

RunGroupTimeoutNotification

任务批次超时通知。

被如下接口引用：DescribeRunGroups。

名称	类型	描述
TimeoutMinutes	Integer	任务批次超时时间，单位分钟。示例值：10
NotificationType	NotificationType	通知类型。

RunMetadata

任务作业详情。

被如下接口引用：GetRunCalls, GetRunStatus。

名称	类型	描述
RunType	String	任务类型。示例值：Task
RunId	String	任务ID。示例值：136452da-edd8-4aa1-abf3-bba0c8a73bba-PairedEndSingleSampleWorkflow.BaseRecalibrator-PairedEndSingleSampleWorkflow.BaseRecalibrator-0
ParentId	String	父层ID。示例值：136452da-edd8-4aa1-abf3-bba0c8a73bba-PairedEndSingleSampleWorkflow.BaseRecalibrator
JobId	String	作业ID。示例值：plan-deliberate-thistle-goose-004544
CallName	String	作业名称。示例值：PairedEndSingleSampleWorkflow.BaseRecalibrator-0
ScatterIndex	String	Scatter索引。示例值：-0
Input	String	输入。
Output	String	输出。示例值：{"recalibration_report": "/vol-4kmq63d5/env/env-5ehsk9fq/execution/PairedEndSingleSampleWorkflow/136452da-edd8-4aa1-abf3-bba0c8a73bba/call-BaseRecalibrator/shard-0/execution/NA12878.recal_data.csv"}
Status	String	状态示例值：COMPLETE
ErrorMessage	String	错误信息。
StartTime	Timestamp ISO8601	开始时间示例值：2024-11-08T17:29:08+08:00
SubmitTime	Timestamp ISO8601	提交时间。示例值：2024-11-08T17:29:08+08:00
EndTime	Timestamp ISO8601	结束时间。示例值：2024-11-08T17:31:29+08:00
Command	String	命令行。
Runtime	String	运行时。示例值：{"preemptible": "false", "failOnStderr": "false", "continueOnReturnCode": "0", "docker": "ccr.ccs.tencentyun.com/omics-public/gatk:4.0.11.0", "maxRetries": "0", "cpu": "2", "memory": "8 GB"}
Preprocess	Boolean	预处理。示例值：false
PostProcess	Boolean	后处理。示例值：false
CallCached	Boolean	Cache命中示例值：false
WorkDir	String	工作目录。示例值：/vol-4kmq63d5
Stdout	String	标准输出。示例值：/vol-4kmq63d5/env/env-5ehsk9fq/execution/PairedEndSingleSampleWorkflow/136452da-edd8-4aa1-abf3-bba0c8a73bba/call-BaseRecalibrator/shard-0/execution/stdout
Stderr	String	错误输出。示例值：/vol-4kmq63d5/env/env-5ehsk9fq/execution/PairedEndSingleSampleWorkflow/136452da-edd8-4aa1-abf3-bba0c8a73bba/call-BaseRecalibrator/shard-0/execution/stderr
Meta	String	其他信息。示例值：{"key":"value"}

RunOption

运行应用选项。

被如下接口引用：DescribeRunGroups, RetryRuns, RunApplication。

名称	类型	必选	描述
FailureMode	String	是	运行失败模式，取值范围： - ContinueWhilePossible - NoNewCalls 示例值：NoNewCalls
UseCallCache	Boolean	是	是否使用Call-Caching功能。示例值：false
UseErrorOnHold	Boolean	是	是否使用错误挂起功能。示例值：false
FinalWorkflowOutputsDir	String	否	输出归档COS路径。示例值：cos://bucket/out
UseRelativeOutputPaths	Boolean	否	是否使用相对目录归档输出。示例值：false
AddRunInfoToOutputDir	Boolean	否	是否添加运行信息到输出目录中示例值：true

RunStatusCount

任务运行状态。

被如下接口引用：DescribeRunGroups。

名称	类型	描述
Status	String	状态。示例值：SUCCESS
Count	Integer	数量。示例值：1

SecurityGroupOption

安全组配置。

被如下接口引用：CreateEnvironment。

名称	类型	必选	描述
SecurityGroupId	String	是	安全组ID。示例值：sg-cml3s14x

StorageOption

文件存储配置。

被如下接口引用：CreateEnvironment。

名称	类型	必选	描述
StorageType	String	是	文件存储类型，取值范围： - SD：通用标准型 - HP：通用性能型 - TB：turbo标准型 - TP：turbo性能型示例值：SD
Zone	String	是	文件存储可用区。示例值：ap-guangzhou-6
Capacity	Integer	否	文件系统容量，turbo系列必填，单位为GiB。 - turbo标准型起售40TiB，即40960GiB；扩容步长20TiB，即20480 GiB。 - turbo性能型起售20TiB，即20480 GiB；扩容步长10TiB，即10240 GiB。示例值：40960
EnableAutoScaleUp	Boolean	否	是否开启默认扩容，仅turbo类型文件存储支持示例值：false
MetaType	String	否	turbo文件系统元数据属性，basic：标准型元数据；enhanced：增强型元数据示例值：basic

Table

表格。

被如下接口引用：DescribeTables。

名称	类型	描述
TableId	String	表格ID 示例值：tab-abbreviated-celadon-hedgehog-456265
ProjectId	String	关联项目ID 示例值：prj-rich-cerise-skunk-566046
Name	String	表格名称示例值：testTable
Description	String	表格描述示例值：a test table
Columns	Array of TableColumn	表格列示例值：[{"Header": "runId","DataType": "String"},{"Header": "fileName","DataType": "String"}]
CreateTime	String	创建时间示例值：2023-03-29 09:30:12
Creator	String	创建人示例值：manager
CreatorId	String	创建人ID 示例值：3d6c13a9-ea99-43a5-9a30-828b5b23f5a2

TableColumn

表格列。

被如下接口引用：DescribeTables。

名称	类型	描述
Header	String	列名称示例值：runId
DataType	String	列数据类型示例值：String

TableRow

表格行。

被如下接口引用：DescribeTablesRows。

名称	类型	描述
TableRowUuid	String	表格行UUID。示例值：d247e309-bfe0-4910-b1e4-cae64c47f786
Content	Array of String	表格行内容。示例值：["1","cos://bucket/batch_test/input/1.txt"]

VPCOption

私有网络配置。

被如下接口引用：CreateEnvironment。

名称	类型	必选	描述
VPCId	String	否	私有网络ID（VPCId和VPCCIDRBlock必选其一。若使用VPCId，则使用现用私有网络；若使用VPCCIDRBlock，则创建新的私有网络）示例值：vpc-codnv14w
SubnetId	String	否	子网ID（SubnetId和SubnetZone&SubnetCIDRBlock必选其一。若使用SubnetId，则使用现用子网；若使用SubnetZone&SubnetCIDRBlock，则创建新的子网）示例值：subnet-schfcd1x
SubnetZone	String	否	子网可用区。示例值：ap-guangzhou-6
VPCCIDRBlock	String	否	私有网络CIDR。示例值：10.8.0.0/16
SubnetCIDRBlock	String	否	子网CIDR。示例值：10.8.16.0/20

Volume

缓存卷。

被如下接口引用：DescribeVolumes。

名称	类型	描述
VolumeId	String	缓存卷ID。示例值：vol-chs8x9
Name	String	名称。示例值：默认数据卷
Description	String	描述。示例值：默认数据卷
EnvironmentId	String	环境ID。示例值：env-ctsf73
Type	String	缓存卷类型，取值范围： * SHARED：多点挂载共享存储示例值：SHARED
Spec	String	缓存卷规格，取值范围： - SD：通用标准型 - HP：通用性能型 - TB：turbo标准型 - TP：turbo性能型示例值：HP
Capacity	Integer	缓存卷大小（GB）。示例值：1024
Usage	Integer	缓存卷使用量（Byte）。示例值：1024
BandwidthLimit	Float	缓存卷吞吐上限（MiB/s）。示例值：200
DefaultMountPath	String	默认挂载路径。示例值：/vlm-vhs6snl
IsDefault	Boolean	是否为默认缓存卷。示例值：true
Status	String	状态。示例值：AVAILABLE
AutoScaleUpRule	VolumeAutoScaleUpRule	turbo自动扩容策略
MetaType	String	turbo元数据属性示例值：basic
Zone	String	可用区示例值：ap-guangzhou-6

VolumeAutoScaleUpRule

缓存卷自动扩容策略

被如下接口引用：DescribeVolumes。

名称	类型	描述
Status	String	自动扩容策略开启，关闭示例值：open,close 示例值：open
ScaleThreshold	Integer	集群用量占比，到达这个值后开始扩容,范围[10-90] 示例值：85
TargetThreshold	Integer	扩容后使用量跟集群总量比例,范围[10-90] 示例值：70

VolumeInfo

缓存卷信息。

被如下接口引用：DescribeRunGroups。

名称	类型	描述
VolumeId	String	缓存卷ID。示例值：vol-cdg4wx
Name	String	名称。示例值：testVolume
MountPath	String	挂载路径。示例值：/vol-cdg4wx

数据结构

本页目录：

ApplicationVersion

CVMOption

CacheInfo

ClusterOption

CosFileInfo

DatabaseOption

Environment

EnvironmentConfig

ExecutionTime

Filter

GitInfo

LimitRange

NFOption

NotificationType

ResourceIds

ResourceQuota

Run

RunGroup

RunGroupNotification

RunGroupResultNotification

RunGroupTimeoutNotification

RunMetadata

RunOption

RunStatusCount

SecurityGroupOption

StorageOption

Table

TableColumn

TableRow

VPCOption

Volume

VolumeAutoScaleUpRule

VolumeInfo