帮你快速理解、总结文档立即下载

数据结构

最近更新时间:2026-04-13 02:35:36
我的收藏

Application

应用详情

被如下接口引用:DescribeApplications。

名称 类型 描述
ApplicationId String

应用ID


示例值:app-unique-olive-yeti-950894
ProjectId String

项目ID


示例值:prj-efficient-maroon-slug-075080
Name String

名称


示例值:scBERT_test_1
Description String

描述


示例值:开发调试
Type String

类型

枚举值:

  • WDL: WDL
  • NEXTFLOW: NEXTFLOW

示例值:NEXTFLOW
Entrypoint String

代码入口


示例值:nextflow/scBERT.nf
CreateTime String

创建时间


示例值:2026-04-07 14:33:21
UpdateTime String

更新时间


示例值:2026-04-07 14:33:21
Creator String

创建人


示例值:100031066699
CreatorId String

创建人ID


示例值:100031066699
VersionCount Integer

版本数量


示例值:0
Versions Array of ApplicationVersion

版本列表

GitSource GitInfo

GIT信息

RunConstraints RunConstraints

运行限制

CosSource CosFileInfo

应用COS文件信息

SortOrder Integer

排序顺序


示例值:1

ApplicationVersion

应用版本。

被如下接口引用:DescribeApplicationVersions, DescribeApplications, 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 否

资源配额。

LimitRange LimitRange 否

限制范围。

SystemNodeInstanceType String 否

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


示例值:SA3.MEDIUM4
SystemNodeCount Integer 否

系统节点池实例数量。


示例值:2
AutoUpgradeClusterLevel Boolean 否

纳管环境自动升配


示例值:false

CosFileInfo

COS 文件信息

被如下接口引用:DescribeApplicationVersions, DescribeApplications。

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

CromwellConfig

Cromwell工作流引擎设置

被如下接口引用:DescribeEnvironments。

名称 类型 必选 描述
MaxConcurrentWorkflows Integer 是 工作流并发数
示例值:20
ConcurrentJobLimit Integer 是 作业并发数
示例值:100

DatabaseOption

数据库配置。

被如下接口引用:CreateEnvironment。

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

Environment

组学平台环境详情。

被如下接口引用:DescribeEnvironments。

名称 类型 描述
EnvironmentId String 环境ID。
示例值:env-lljckw12
Name String 环境名称。
示例值:新环境
Description String 环境描述信息。
示例值:用于测试
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 环境是否为默认环境。
示例值:true
IsManaged Boolean 环境是否为托管环境。
示例值:false
Message String 环境信息。
示例值:环境正常
ResourceIds ResourceIds 云资源ID。
LastWorkflowUuid String 上个工作流UUID。
示例值:94922fcd-107e-4220-9a0f-cc3cd84a9a27
CreationTime Timestamp ISO8601 创建时间。
示例值:2022-12-14T16:14:49+08:00
RuntimeConfig EnvironmentRuntimeConfig 运行时配置。

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"}

EnvironmentRuntimeConfig

环境运行时配置

被如下接口引用:DescribeEnvironments。

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

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)关系。

被如下接口引用:DescribeApplications, DescribeEnvironments, DescribeHPCClusters, DescribeHPCNodes, DescribeInputTemplates, DescribeProjects, DescribeRunGroups, DescribeRuns, DescribeTables, DescribeTablesRows, DescribeVolumes。

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

GitInfo

Git信息。

被如下接口引用:DescribeApplicationVersions, DescribeApplications, 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

HPCCluster

HPC集群

被如下接口引用:DescribeHPCClusters。

名称 类型 描述
ClusterId String 集群ID
示例值:cls-8dc20exc
Name String 名称
示例值:组学分析集群
Description String 描述
示例值:高性能计算专用
Status String 状态
示例值:RUNNING
Scheduler String 调度器
示例值:SLURM
VPCId String VPC ID
示例值:vpc-0efb24n1
NodeCount Integer 节点数量
示例值:10
Tags Array of Tag 标签
CreateTime Timestamp ISO8601 创建时间
示例值:2024-10-10T16:00:00+08:00
Type String 集群类型
示例值:CVM_CLUSTER
OsName String 系统名称
示例值:CentOS 7.9
SchedulerVersion String 调度器版本
示例值:23.11.7
VPCCIDRBlock String 集群VPC CIDR
示例值:10.0.0.0/8
ConfirmDeadline String 集群确认交付截止日期
示例值:2026-01-14T12:00:00+08:00

HPCDisk

HPC实例硬盘

被如下接口引用:DescribeHPCNodes。

名称 类型 必选 描述
DiskId String 否 硬盘ID。仅作为出参。
Size Integer 否 硬盘大小
Type String 否 类型

HPCGPUInfo

HPC实例GPU

被如下接口引用:DescribeHPCNodes。

名称 类型 必选 描述
GPUType String 否 GPU类型
GPUCount Float 否 GPU数量

HPCInstance

HPC实例

被如下接口引用:DescribeHPCNodes。

名称 类型 必选 描述
InstanceId String 否 实例ID
Name String 否 名称
CPU Integer 否 CPU数量
Memory Integer 否 内存
State String 否 状态
Type String 否 类型
ChargeType String 否 计费类型
OSName String 否 系统名称
SystemDisk HPCDisk 否 系统盘
GPUInfo HPCGPUInfo 否 GPU
PrivateIPAddresses Array of String 否 内网IP地址
PublicIPAddresses Array of String 否 公网IP地址
CreateTime Timestamp ISO8601 否 创建时间
ExpireTime Timestamp ISO8601 否 到期时间
Uuid String 否 Uuid
示例值:41fvaf44-9689-42v2-9020-aeea7dbde938
InternetInfo HPCInternetInfo 否 节点网络信息

HPCInternetInfo

HPC节点网络信息

被如下接口引用:DescribeHPCNodes。

名称 类型 必选 描述
InternetMaxBandwidthOut Integer 否

网络出口带宽,单位Mbps


示例值:10
InternetChargeType String 否

网络收费类型

枚举值:

  • BANDWIDTH_PREPAID: 预付费按带宽结算
  • TRAFFIC_POSTPAID_BY_HOUR: 流量按小时后付费
  • BANDWIDTH_POSTPAID_BY_HOUR: 带宽按小时后付费

示例值:BANDWIDTH_POSTPAID_BY_HOUR

HPCNode

HPC节点

被如下接口引用:DescribeHPCNodes。

名称 类型 必选 描述
NodeId String 否

节点ID


示例值:node-51o37so9
QueueId String 否

队列ID


示例值:queue-xc2scs
ClusterId String 否

集群ID


示例值:hpc-ejvu71p7
Role String 否

角色


示例值:COMPUTE
Type String 否

类型


示例值:DYNAMIC
Zone String 否

可用区


示例值:ap-guangzhou-6
ImageId String 否

镜像ID


示例值:img-4npznz7u
Instance HPCInstance 否

实例信息

Tags Array of Tag 否

标签

Name String 否

节点名称


示例值:dynamic-node-51o37so9
QueueName String 否

队列名称


示例值:compute
Status String 否

节点状态。取值范围:
IDLE 空闲
DOWN 节点下线
MIXED 节点部分使用
ALLOC 节点完全分配
DRAIN 排空,不接受新任务


示例值:IDLE

InputTemplate

运行参数模板

被如下接口引用:DescribeInputTemplates。

名称 类型 必选 描述
Uuid String 否

唯一ID


示例值:0e5c1233-bdad-4541-9e15-39f39a46c934
InputTemplateId String 否

应用输入模板ID


示例值:in-best-teal-gorilla-731558
ProjectId String 否

关联项目ID


示例值:prj-efficient-maroon-slug-075080
ApplicationId String 否

关联应用ID


示例值:in-best-teal-gorilla-731558
ApplicationVersionId String 否

关联应用版本


示例值:0
Name String 否

名称


示例值:test-template
Description String 否

描述


示例值:添加描述测试
Creator String 否

创建人


示例值:chanh_test
CreatorId String 否

创建人ID


示例值:a7a67c817c5b4012adde352c045295ba

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

NextflowConfig

Nextflow工作流引擎设置

被如下接口引用:DescribeEnvironments。

名称 类型 必选 描述
ExecutorQueueSize Integer 是 工作流任务并发数
示例值:100

NotificationType

通知类型

被如下接口引用:DescribeRunGroups。

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

Project

项目信息

被如下接口引用:DescribeProjects。

名称 类型 描述
ProjectId String

项目ID


示例值:prj-wide-cerulean-cicadia-967487
Name String

名称


示例值:demo project for testing
Description String

描述


示例值:2
Region String

地域


示例值:ap-guangzhou
CreateTime String

创建时间


示例值:2023-10-25 20:17:58
UpdateTime String

更新时间


示例值:2025-12-11 16:08:17
Creator String

创建人


示例值:OneID账号62896595
IsDefault Boolean

是否默认项目


示例值:true

PublicApplication

公共应用。

被如下接口引用:DescribePublicApplications。

名称 类型 描述
ApplicationId String

应用ID。


示例值:publicapp-nf-ori-collection
Name String

名称。


示例值:ORI Collection (Nextflow)
Type String

类型。


示例值:NEXTFLOW
AppGroupType String

应用标记

枚举值:

  • SUB_APP: 子应用
  • APP_COLLECTION: 合集
  • STANDALONE_APP: 独立应用

示例值:APP_COLLECTION
NextflowVersion Array of String

Nextflow版本


示例值:["v23.10.3"]
AppTags Array of ToolRepoTag

应用分类

AppId String

应用标识


示例值:5c63718b-d24f-4a9f-9838-4177185f414a

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

RunConstraints

运行限制

被如下接口引用:DescribeApplications。

名称 类型 必选 描述
NextflowVersion Array of String 否

运行时可选的Nextflow版本


示例值:["v24.04.3"]

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"]

Tag

标签

被如下接口引用:DescribeHPCClusters, DescribeHPCNodes。

名称 类型 必选 描述
Key String 是 标签键
Value String 是 标签值

ToolRepoTag

应用分类标签

被如下接口引用:DescribePublicApplications。

名称 类型 必选 描述
TagId String 否

应用分类标签ID


示例值:fbf53a9e-3acc-45cb-b47e-c2118e3f258b
TagName String 否

应用分类标签名称


示例值:宏基因组

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