API 中心

文档中心 API 中心腾讯健康组学平台数据结构

数据结构

最近更新时间：2024-03-04 01:21:11

我的收藏

本页目录：

ApplicationVersion

应用版本。

被如下接口引用：DescribeRunGroups。

名称	类型	描述
Type	String	版本类型。注意：此字段可能返回 null，表示取不到有效值。
ApplicationVersionId	String	版本ID。注意：此字段可能返回 null，表示取不到有效值。
Name	String	发布名称。注意：此字段可能返回 null，表示取不到有效值。
Description	String	发布描述。注意：此字段可能返回 null，表示取不到有效值。
Entrypoint	String	入口文件。注意：此字段可能返回 null，表示取不到有效值。
CreateTime	String	创建时间。注意：此字段可能返回 null，表示取不到有效值。
CreatorName	String	创建者名称。注意：此字段可能返回 null，表示取不到有效值。
CreatorId	String	创建者ID。注意：此字段可能返回 null，表示取不到有效值。
GitInfo	String	Git信息。注意：此字段可能返回 null，表示取不到有效值。

CVMOption

云服务器配置。

被如下接口引用：CreateEnvironment。

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

CacheInfo

缓存信息。

被如下接口引用：DescribeRuns。

名称	类型	描述
CacheClearDelay	Integer	缓存清理时间(小时)。注意：此字段可能返回 null，表示取不到有效值。
CacheClearTime	Timestamp ISO8601	缓存清理计划时间。注意：此字段可能返回 null，表示取不到有效值。
CacheCleared	Boolean	缓存是否已被清理。注意：此字段可能返回 null，表示取不到有效值。

ClusterOption

计算集群配置。

被如下接口引用：CreateEnvironment。

名称	类型	必选	描述
Zone	String	是	计算集群可用区。示例值：ap-guangzhou-6
Type	String	是	计算集群类型，取值范围： - KUBERNETES 示例值：KUBERNETES
ServiceCidr	String	否	计算集群Service CIDR，不能与VPC网段重合。示例值：192.168.0.0/20
ResourceQuota	ResourceQuota	否	资源配额。
LimitRange	LimitRange	否	限制范围。

DatabaseOption

数据库配置。

被如下接口引用：CreateEnvironment。

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

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。注意：此字段可能返回 null，表示取不到有效值。
CreationTime	Timestamp ISO8601	创建时间。注意：此字段可能返回 null，表示取不到有效值。

EnvironmentConfig

环境配置。

被如下接口引用：CreateEnvironment。

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

ExecutionTime

执行时间。

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

名称	类型	描述
SubmitTime	Timestamp ISO8601	提交时间。注意：此字段可能返回 null，表示取不到有效值。
StartTime	Timestamp ISO8601	开始时间。注意：此字段可能返回 null，表示取不到有效值。
EndTime	Timestamp ISO8601	结束时间。注意：此字段可能返回 null，表示取不到有效值。

Filter

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

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

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

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

GitInfo

Git信息。

被如下接口引用：RunWorkflow。

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

LimitRange

资源限制范围。

被如下接口引用：CreateEnvironment。

名称	类型	必选	描述
MaxCPU	String	否	最大CPU设置注意：此字段可能返回 null，表示取不到有效值。
MaxMemory	String	否	最大内存设置（单位：Mi，Gi，Ti，M，G，T）注意：此字段可能返回 null，表示取不到有效值。

NFOption

Nextflow选项。

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

名称	类型	必选	描述
Config	String	否	Config。注意：此字段可能返回 null，表示取不到有效值。
Profile	String	否	Profile。注意：此字段可能返回 null，表示取不到有效值。
Report	Boolean	否	Report。注意：此字段可能返回 null，表示取不到有效值。
Resume	Boolean	否	Resume。注意：此字段可能返回 null，表示取不到有效值。
NFVersion	String	否	Nextflow引擎版本，取值范围： - 22.10.4 - 22.10.8 - 23.10.1 注意：此字段可能返回 null，表示取不到有效值。

ResourceIds

云资源ID。

被如下接口引用：DescribeEnvironments。

名称	类型	描述
VPCId	String	私有网络ID。注意：此字段可能返回 null，表示取不到有效值。
SubnetId	String	子网ID。注意：此字段可能返回 null，表示取不到有效值。
SecurityGroupId	String	安全组ID。注意：此字段可能返回 null，表示取不到有效值。
TDSQLCId	String	TDSQL-C Mysql版数据库ID。注意：此字段可能返回 null，表示取不到有效值。
CFSId	String	文件存储ID。注意：此字段可能返回 null，表示取不到有效值。
CFSStorageType	String	文件存储类型：取值范围： - SD：通用标准型 - HP：通用性能型 - TB：turbo标准型 - TP：turbo性能型注意：此字段可能返回 null，表示取不到有效值。
CVMId	String	云服务器ID。注意：此字段可能返回 null，表示取不到有效值。
EKSId	String	弹性容器集群ID。注意：此字段可能返回 null，表示取不到有效值。

ResourceQuota

资源配额。

被如下接口引用：CreateEnvironment。

名称	类型	必选	描述
CPULimit	String	否	CPU Limit设置。注意：此字段可能返回 null，表示取不到有效值。
MemoryLimit	String	否	内存Limit设置（单位：Mi，Gi，Ti，M，G，T）注意：此字段可能返回 null，表示取不到有效值。
Pods	String	否	Pods数量设置注意：此字段可能返回 null，表示取不到有效值。

Run

任务。

被如下接口引用：DescribeRuns。

名称	类型	描述
RunUuid	String	任务UUID。
ProjectId	String	项目ID。
ApplicationId	String	应用ID。
RunGroupId	String	任务批次ID。
EnvironmentId	String	环境ID。
UserDefinedId	String	用户定义ID，单例运行为空。注意：此字段可能返回 null，表示取不到有效值。
TableId	String	表格ID，单例运行为空。注意：此字段可能返回 null，表示取不到有效值。
TableRowUuid	String	表格行UUID，单例运行为空。注意：此字段可能返回 null，表示取不到有效值。
Status	String	任务状态。
Input	String	任务输入。
ExecutionTime	ExecutionTime	执行时间。
Cache	CacheInfo	缓存信息。注意：此字段可能返回 null，表示取不到有效值。
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	应用类型。
EnvironmentId	String	环境ID。
EnvironmentName	String	环境名称。
TableId	String	表格ID，单例运行为空。注意：此字段可能返回 null，表示取不到有效值。
Name	String	任务名称。
Description	String	任务描述。
Status	String	任务状态。
Input	String	任务输入。
Option	RunOption	WDL运行选项。
NFOption	NFOption	Nextflow运行选项。注意：此字段可能返回 null，表示取不到有效值。
TotalRun	Integer	任务总数量。
RunStatusCounts	Array of RunStatusCount	各状态任务的数量。
ExecutionTime	ExecutionTime	执行时间。
ErrorMessage	String	错误信息。
CreateTime	Timestamp ISO8601	创建时间。
UpdateTime	Timestamp ISO8601	更新时间。
Creator	String	创建者。注意：此字段可能返回 null，表示取不到有效值。
CreatorId	String	创建者ID。注意：此字段可能返回 null，表示取不到有效值。
ResultNotify	String	运行结果通知方式。注意：此字段可能返回 null，表示取不到有效值。
ApplicationVersion	ApplicationVersion	应用版本。注意：此字段可能返回 null，表示取不到有效值。

RunMetadata

任务作业详情。

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

名称	类型	描述
RunType	String	任务类型。注意：此字段可能返回 null，表示取不到有效值。
RunId	String	任务ID。注意：此字段可能返回 null，表示取不到有效值。
ParentId	String	父层ID。注意：此字段可能返回 null，表示取不到有效值。
JobId	String	作业ID。注意：此字段可能返回 null，表示取不到有效值。
CallName	String	作业名称。注意：此字段可能返回 null，表示取不到有效值。
ScatterIndex	String	Scatter索引。注意：此字段可能返回 null，表示取不到有效值。
Input	String	输入。注意：此字段可能返回 null，表示取不到有效值。
Output	String	输出。注意：此字段可能返回 null，表示取不到有效值。
Status	String	状态注意：此字段可能返回 null，表示取不到有效值。
ErrorMessage	String	错误信息。注意：此字段可能返回 null，表示取不到有效值。
StartTime	Timestamp ISO8601	开始时间注意：此字段可能返回 null，表示取不到有效值。
SubmitTime	Timestamp ISO8601	提交时间。注意：此字段可能返回 null，表示取不到有效值。
EndTime	Timestamp ISO8601	结束时间。注意：此字段可能返回 null，表示取不到有效值。
Command	String	命令行。注意：此字段可能返回 null，表示取不到有效值。
Runtime	String	运行时。注意：此字段可能返回 null，表示取不到有效值。
Preprocess	Boolean	预处理。注意：此字段可能返回 null，表示取不到有效值。
PostProcess	Boolean	后处理。注意：此字段可能返回 null，表示取不到有效值。
CallCached	Boolean	Cache命中注意：此字段可能返回 null，表示取不到有效值。
Stdout	String	标准输出。注意：此字段可能返回 null，表示取不到有效值。
Stderr	String	错误输出。注意：此字段可能返回 null，表示取不到有效值。
Meta	String	其他信息。注意：此字段可能返回 null，表示取不到有效值。

RunOption

运行应用选项。

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

名称	类型	必选	描述
FailureMode	String	是	运行失败模式，取值范围： - ContinueWhilePossible - NoNewCalls
UseCallCache	Boolean	是	是否使用Call-Caching功能。
UseErrorOnHold	Boolean	是	是否使用错误挂起功能。
FinalWorkflowOutputsDir	String	否	输出归档COS路径。注意：此字段可能返回 null，表示取不到有效值。
UseRelativeOutputPaths	Boolean	否	是否使用相对目录归档输出。注意：此字段可能返回 null，表示取不到有效值。

RunStatusCount

任务运行状态。

被如下接口引用：DescribeRunGroups。

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

SecurityGroupOption

安全组配置。

被如下接口引用：CreateEnvironment。

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

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

Table

表格。

被如下接口引用：DescribeTables。

名称	类型	描述
TableId	String	表格ID 注意：此字段可能返回 null，表示取不到有效值。
ProjectId	String	关联项目ID 注意：此字段可能返回 null，表示取不到有效值。
Name	String	表格名称注意：此字段可能返回 null，表示取不到有效值。
Description	String	表格描述注意：此字段可能返回 null，表示取不到有效值。
Columns	Array of TableColumn	表格列注意：此字段可能返回 null，表示取不到有效值。
CreateTime	String	创建时间注意：此字段可能返回 null，表示取不到有效值。
Creator	String	创建人注意：此字段可能返回 null，表示取不到有效值。

TableColumn

表格列。

被如下接口引用：DescribeTables。

名称	类型	描述
Header	String	列名称注意：此字段可能返回 null，表示取不到有效值。
DataType	String	列数据类型注意：此字段可能返回 null，表示取不到有效值。

TableRow

表格行。

被如下接口引用：DescribeTablesRows。

名称	类型	描述
TableRowUuid	String	表格行UUID。注意：此字段可能返回 null，表示取不到有效值。
Content	Array of String	表格行内容。注意：此字段可能返回 null，表示取不到有效值。

VPCOption

私有网络配置。

被如下接口引用：CreateEnvironment。

名称	类型	必选	描述
VPCId	String	否	私有网络ID（VPCId和VPCCIDRBlock必选其一。若使用VPCId，则使用现用私有网络；若使用VPCCIDRBlock，则创建新的私有网络）
SubnetId	String	否	子网ID（SubnetId和SubnetZone&SubnetCIDRBlock必选其一。若使用SubnetId，则使用现用子网；若使用SubnetZone&SubnetCIDRBlock，则创建新的子网）
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。注意：此字段可能返回 null，表示取不到有效值。示例值：vol-chs8x9
Name	String	名称。注意：此字段可能返回 null，表示取不到有效值。示例值：默认数据卷
Description	String	描述。注意：此字段可能返回 null，表示取不到有效值。示例值：默认数据卷
EnvironmentId	String	环境ID。注意：此字段可能返回 null，表示取不到有效值。
Type	String	缓存卷类型，取值范围： * SHARED：多点挂载共享存储注意：此字段可能返回 null，表示取不到有效值。示例值：SHARED
Spec	String	缓存卷规格，取值范围： - SD：通用标准型 - HP：通用性能型 - TB：turbo标准型 - TP：turbo性能型注意：此字段可能返回 null，表示取不到有效值。示例值：HP
Capacity	Integer	缓存卷大小（GB）。注意：此字段可能返回 null，表示取不到有效值。示例值：1024
Usage	Integer	缓存卷使用量（Byte）。注意：此字段可能返回 null，表示取不到有效值。示例值：1024
BandwidthLimit	Float	缓存卷吞吐上限（MiB/s）。注意：此字段可能返回 null，表示取不到有效值。示例值：200
DefaultMountPath	String	默认挂载路径。注意：此字段可能返回 null，表示取不到有效值。示例值：/vlm-vhs6snl
IsDefault	Boolean	是否为默认缓存卷。注意：此字段可能返回 null，表示取不到有效值。示例值：true
Status	String	状态。注意：此字段可能返回 null，表示取不到有效值。示例值：AVAILABLE