tencent cloud

APIs

文档APIsTencent HealthCare Omics PlatformData Types

数据结构

聚焦模式
字号
最后更新时间： 2026-05-08 15:20:16

ApplicationVersion

应用版本。

被如下接口引用：DescribeRunGroups。

名称 类型 描述
Type String 版本类型。
ApplicationVersionId String 版本ID。
Name String 发布名称。
Description String 发布描述。
Entrypoint String 入口文件。
CreateTime String 创建时间。
CreatorName String 创建者名称。
CreatorId String 创建者ID。
GitSource GitInfo Git信息。
CosSource CosFileInfo COS信息。

CVMOption

云服务器配置。

被如下接口引用：CreateEnvironment。

名称 类型 必选 描述
Zone String 是

云服务器可用区。
InstanceType String 是

云服务器实例规格。详情参见实例规格描述

CacheInfo

缓存信息。

被如下接口引用：DescribeRuns。

名称 类型 描述
CacheClearDelay Integer 缓存清理时间(小时)。
CacheClearTime Timestamp ISO8601 缓存清理计划时间。
CacheCleared Boolean 缓存是否已被清理。

ClusterOption

计算集群配置。

被如下接口引用：CreateEnvironment。

名称 类型 必选 描述
Zone String 是

计算集群可用区。
Type String 是

计算集群类型，取值范围：

  • KUBERNETES
ServiceCidr String 否

计算集群Service CIDR，不能与VPC网段重合。
ResourceQuota ResourceQuota 否

资源配额。
LimitRange LimitRange 否

限制范围。
SystemNodeInstanceType String 否

系统节点池实例规格。详情参见实例规格描述
SystemNodeCount Integer 否

系统节点池实例数量。
AutoUpgradeClusterLevel Boolean 否

纳管环境自动升配

CosFileInfo

COS 文件信息

被如下接口引用：DescribeRunGroups。

名称 类型 必选 描述
Bucket String 是 存储桶。
Uri String 是 COS文件地址。
Region String 否 地域。

CromwellConfig

Cromwell工作流引擎设置

被如下接口引用：DescribeEnvironments。

名称 类型 必选 描述
MaxConcurrentWorkflows Integer 是 工作流并发数
ConcurrentJobLimit Integer 是 作业并发数

DatabaseOption

数据库配置。

被如下接口引用：CreateEnvironment。

名称 类型 必选 描述
Zone String 是 数据库可用区。

Environment

组学平台环境详情。

被如下接口引用：DescribeEnvironments。

名称 类型 描述
EnvironmentId String 环境ID。
Name String 环境名称。
Description String 环境描述信息。
Region String 环境地域。
Type String 环境类型，取值范围：
- KUBERNETES：Kubernetes容器集群
- HPC：HPC高性能计算集群
Status String 环境状态，取值范围：
- INITIALIZING：创建中
- INITIALIZATION_ERROR：创建失败
- RUNNING：运行中
- ERROR：异常
- DELETING：正在删除
- DELETE_ERROR：删除失败
Available Boolean 环境是否可用。环境需要可用才能投递计算任务。
IsDefault Boolean 环境是否为默认环境。
IsManaged Boolean 环境是否为托管环境。
Message String 环境信息。
ResourceIds ResourceIds 云资源ID。
LastWorkflowUuid String 上个工作流UUID。
CreationTime Timestamp ISO8601 创建时间。
RuntimeConfig EnvironmentRuntimeConfig 运行时配置。

EnvironmentConfig

环境配置。

被如下接口引用：CreateEnvironment。

名称 类型 必选 描述
VPCOption VPCOption 是 私有网络配置。
ClusterOption ClusterOption 是 计算集群配置。
DatabaseOption DatabaseOption 是 数据库配置。
StorageOption StorageOption 是 存储配置。
CVMOption CVMOption 是 云服务器配置。
SecurityGroupOption SecurityGroupOption 否 安全组配置。

EnvironmentRuntimeConfig

环境运行时配置

被如下接口引用：DescribeEnvironments。

名称 类型 必选 描述
CromwellConfig CromwellConfig 是 Cromwell工作流引擎设置
NextflowConfig NextflowConfig 是 Nextflow工作流引擎设置

ExecutionTime

执行时间。

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

名称 类型 描述
SubmitTime Timestamp ISO8601 提交时间。
StartTime Timestamp ISO8601 开始时间。
EndTime Timestamp ISO8601 结束时间。

Filter

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

  • 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。

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

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

名称 类型 必选 描述
Name String 是 过滤字段。
Values Array of String 是 过滤字段值。

GitInfo

Git信息。

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

名称 类型 必选 描述
GitHttpPath String 是 Git地址。
GitUserName String 否 Git用户名。
GitTokenOrPassword String 否 Git密码或者Token。
Branch String 否 分支。
Tag String 否 标签。

LimitRange

资源限制范围。

被如下接口引用：CreateEnvironment。

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

NFOption

Nextflow选项。

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

名称 类型 必选 描述
Config String 否 Config。
Profile String 否 Profile。
Report Boolean 否 Report。
Resume Boolean 否 Resume。
NFVersion String 否 Nextflow引擎版本，取值范围：
- 22.10.7
- 23.10.1
LaunchDir String 否 启动路径。可填写指定缓存卷内的绝对路径，nextflow run 命令将在此路径执行。当WorkDir为COS路径时必填；当WorkDir为缓存卷路径时选填，不填默认使用WorkDir作为LaunchDir。

NextflowConfig

Nextflow工作流引擎设置

被如下接口引用：DescribeEnvironments。

名称 类型 必选 描述
ExecutorQueueSize Integer 是 工作流任务并发数

NotificationType

通知类型

被如下接口引用：DescribeRunGroups。

名称 类型 描述
StationMessage Boolean 腾讯健康组学平台站点信息。
Email Array of String 邮箱列表。
CurrentUserEmail Boolean 当前用户邮箱。

ResourceIds

云资源ID。

被如下接口引用：DescribeEnvironments。

名称 类型 描述
VPCId String 私有网络ID。
SubnetId String 子网ID。
SecurityGroupId String 安全组ID。
TDSQLCId String TDSQL-C Mysql版数据库ID。
CFSId String 文件存储ID。
CFSStorageType String 文件存储类型：取值范围：
- SD：通用标准型
- HP：通用性能型
- TB：turbo标准型
- TP：turbo性能型
CVMId String 云服务器ID。
EKSId String 弹性容器集群ID。
TKEId String TKE容器集群ID。
TKESystemNodePoolId String TKE系统节点池ID。

ResourceQuota

资源配额。

被如下接口引用：CreateEnvironment。

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

Run

任务。

被如下接口引用：DescribeRuns。

名称 类型 描述
RunUuid String 任务UUID。
ProjectId String 项目ID。
ApplicationId String 应用ID。
RunGroupId String 任务批次ID。
EnvironmentId String 环境ID。
UserDefinedId String 用户定义ID，单例运行为空。
TableId String 表格ID，单例运行为空。
TableRowUuid String 表格行UUID，单例运行为空。
Status String 任务状态。
Input String 任务输入。
ExecutionTime ExecutionTime 执行时间。
Cache CacheInfo 缓存信息。
ErrorMessage String 错误信息。
CreateTime Timestamp ISO8601 创建时间。
UpdateTime Timestamp ISO8601 更新时间。

RunGroup

任务。

被如下接口引用：DescribeRunGroups。

名称 类型 描述
RunGroupId String 任务批次ID。
ProjectId String 项目ID。
ProjectName String 项目名称。
ApplicationId String 应用ID。
ApplicationName String 应用名称。
ApplicationType String 应用类型。
ApplicationVersion ApplicationVersion 应用版本。
AccessMode String 应用访问类型：
- PRIVATE 私有应用
- PUBLIC 公共应用
EnvironmentId String 环境ID。
EnvironmentName String 环境名称。
TableId String 表格ID，单例运行为空。
Name String 任务名称。
Description String 任务描述。
Status String 任务状态。
Type String 任务批次类型 ：
- WDL
- NEXTFLOW
WorkDir String 工作目录。
Input String 任务输入。
InputType String 任务输入类型：
- JSON: 导入JSON
- MANUAL: 手动输入
- COS: COS文件
InputCosUri String 输入COS地址。
InputTemplateId String 输入模板ID。
Option RunOption WDL运行选项。
NFOption NFOption Nextflow运行选项。
Volumes Array of VolumeInfo 使用的缓存卷。
TotalRun Integer 任务总数量。
RunStatusCounts Array of RunStatusCount 各状态任务的数量。
ExecutionTime ExecutionTime 执行时间。
ErrorMessage String 错误信息。
Notification RunGroupNotification 任务批次通知。
CreateTime Timestamp ISO8601 创建时间。
UpdateTime Timestamp ISO8601 更新时间。
Creator String 创建者。
CreatorId String 创建者ID。
ResultNotify String 运行结果通知方式。

RunGroupNotification

任务批次通知。

被如下接口引用：DescribeRunGroups。

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

RunGroupResultNotification

任务批次结果通知

被如下接口引用：DescribeRunGroups。

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

RunGroupTimeoutNotification

任务批次超时通知。

被如下接口引用：DescribeRunGroups。

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

RunMetadata

任务作业详情。

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

名称 类型 描述
RunType String 任务类型。
RunId String 任务ID。
ParentId String 父层ID。
JobId String 作业ID。
CallName String 作业名称。
ScatterIndex String Scatter索引。
Input String 输入。
Output String 输出。
Status String 状态
ErrorMessage String 错误信息。
StartTime Timestamp ISO8601 开始时间
SubmitTime Timestamp ISO8601 提交时间。
EndTime Timestamp ISO8601 结束时间。
Command String 命令行。
Runtime String 运行时。
Preprocess Boolean 预处理。
PostProcess Boolean 后处理。
CallCached Boolean Cache命中
WorkDir String 工作目录。
Stdout String 标准输出。
Stderr String 错误输出。
Meta String 其他信息。

RunOption

运行应用选项。

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

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

RunStatusCount

任务运行状态。

被如下接口引用：DescribeRunGroups。

名称 类型 描述
Status String 状态。
Count Integer 数量。

SecurityGroupOption

安全组配置。

被如下接口引用：CreateEnvironment。

名称 类型 必选 描述
SecurityGroupId String 是 安全组ID。

StorageOption

文件存储配置。

被如下接口引用：CreateEnvironment。

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

Table

表格。

被如下接口引用：DescribeTables。

名称 类型 描述
TableId String 表格ID
ProjectId String 关联项目ID
Name String 表格名称
Description String 表格描述
Columns Array of TableColumn 表格列
CreateTime String 创建时间
Creator String 创建人
CreatorId String 创建人ID

TableColumn

表格列。

被如下接口引用：DescribeTables。

名称 类型 描述
Header String 列名称
DataType String 列数据类型

TableRow

表格行。

被如下接口引用：DescribeTablesRows。

名称 类型 描述
TableRowUuid String 表格行UUID。
Content Array of String 表格行内容。

VPCOption

私有网络配置。

被如下接口引用：CreateEnvironment。

名称 类型 必选 描述
VPCId String 否

私有网络ID（VPCId和VPCCIDRBlock必选其一。若使用VPCId，则使用现用私有网络；若使用VPCCIDRBlock，则创建新的私有网络）
SubnetId String 否

子网ID（SubnetId和SubnetZone&SubnetCIDRBlock必选其一。若使用SubnetId，则使用现用子网；若使用SubnetZone&SubnetCIDRBlock，则创建新的子网）
SubnetZone String 否

子网可用区。
VPCCIDRBlock String 否

私有网络CIDR。
SubnetCIDRBlock String 否

子网CIDR。

Volume

缓存卷。

被如下接口引用：DescribeVolumes。

名称 类型 描述
VolumeId String 缓存卷ID。
Name String 名称。
Description String 描述。
EnvironmentId String 环境ID。
Type String 缓存卷类型，取值范围：
* SHARED：多点挂载共享存储
Spec String 缓存卷规格，取值范围：

- SD：通用标准型
- HP：通用性能型
- TB：turbo标准型
- TP：turbo性能型
Capacity Integer 缓存卷大小（GB）。
Usage Integer 缓存卷使用量（Byte）。
BandwidthLimit Float 缓存卷吞吐上限（MiB/s）。
DefaultMountPath String 默认挂载路径。
IsDefault Boolean 是否为默认缓存卷。
Status String 状态。
AutoScaleUpRule VolumeAutoScaleUpRule turbo自动扩容策略
MetaType String turbo元数据属性
Zone String 可用区

VolumeAutoScaleUpRule

缓存卷自动扩容策略

被如下接口引用：DescribeVolumes。

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

VolumeInfo

缓存卷信息。

被如下接口引用：DescribeRunGroups。

名称 类型 描述
VolumeId String 缓存卷ID。
Name String 名称。
MountPath String 挂载路径。
上一篇: RetryRuns下一篇: Error Codes

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈