Tencent Cloud

Prev Next

search by keyword

Recent Pages

Documentation

Data Types

Last updated: 2024-07-26 15:26:32

ApplicationVersion

Application version

Used by actions: DescribeRunGroups.

Name	Type	Description
Type	String	Version type Note: This field may return null, indicating that no valid values can be obtained.
ApplicationVersionId	String	Version ID Note: This field may return null, indicating that no valid values can be obtained.
Name	String	Release name Note: This field may return null, indicating that no valid values can be obtained.
Description	String	Release description Note: This field may return null, indicating that no valid values can be obtained.
Entrypoint	String	Entry file Note: This field may return null, indicating that no valid values can be obtained.
CreateTime	String	Creation time Note: This field may return null, indicating that no valid values can be obtained.
CreatorName	String	Creator name Note: This field may return null, indicating that no valid values can be obtained.
CreatorId	String	Creator ID Note: This field may return null, indicating that no valid values can be obtained.
GitInfo	String	Git information Note: This field may return null, indicating that no valid values can be obtained.

CVMOption

CVM configuration

Used by actions: CreateEnvironment.

Name	Type	Required	Description
Zone	String	Yes	CVM availability zone
InstanceType	String	Yes	CVM instance specifications

CacheInfo

Cache information

Used by actions: DescribeRuns.

Name	Type	Description
CacheClearDelay	Integer	Cache cleanup time (hours) Note: This field may return null, indicating that no valid values can be obtained.
CacheClearTime	Timestamp ISO8601	Cache cleanup schedule time Note: This field may return null, indicating that no valid values can be obtained.
CacheCleared	Boolean	Whether the cache has been cleaned up Note: This field may return null, indicating that no valid values can be obtained.

ClusterOption

Computing cluster configuration

Used by actions: CreateEnvironment.

Name	Type	Required	Description
Zone	String	Yes	Computing cluster availability zone
Type	String	Yes	Computing cluster type. Valid values: - KUBERNETES
ServiceCidr	String	No	Computing cluster Service CIDR. It must not overlap with the VPC IP range.
ResourceQuota	ResourceQuota	No	Resource quota
LimitRange	LimitRange	No	Limit scope

DatabaseOption

Database configuration

Used by actions: CreateEnvironment.

Name	Type	Required	Description
Zone	String	Yes	Database availability zone

Environment

Tencent Healthcare Omics Platform environment details

Used by actions: DescribeEnvironments.

Name	Type	Description
EnvironmentId	String	Environment ID
Name	String	Environment name
Description	String	Environment description information
Region	String	Environment region
Type	String	Environment type. Valid values: - KUBERNETES: Kubernetes container cluster - HPC:HPC HCC
Status	String	Environment status. Valid values: - INITIALIZING: Creating - INITIALIZATION_ERROR: Creation failed - RUNNING: Running - ERROR: Exceptional - DELETING: Deleting - DELETE_ERROR: Deletion failed.
Available	Boolean	Whether the environment is available. The environment needs to be available before computing runs can be delivered.
IsDefault	Boolean	Whether the environment is the default environment.
IsManaged	Boolean	Whether the environment is a managed environment.
Message	String	Environment information
ResourceIds	ResourceIds	Cloud resource ID
LastWorkflowUuid	String	The UUID of the previous workflow Note: This field may return null, indicating that no valid values can be obtained.
CreationTime	Timestamp ISO8601	Creation time Note: This field may return null, indicating that no valid values can be obtained.

EnvironmentConfig

Environment configuration

Used by actions: CreateEnvironment.

Name	Type	Required	Description
VPCOption	VPCOption	Yes	VPC configuration
ClusterOption	ClusterOption	Yes	Computing cluster configuration
DatabaseOption	DatabaseOption	Yes	Database configuration
StorageOption	StorageOption	Yes	Storage configuration
CVMOption	CVMOption	Yes	CVM configuration
SecurityGroupOption	SecurityGroupOption	No	Security group configuration

ExecutionTime

Execution time

Used by actions: DescribeRunGroups, DescribeRuns.

Name	Type	Description
SubmitTime	Timestamp ISO8601	Submission time Note: This field may return null, indicating that no valid values can be obtained.
StartTime	Timestamp ISO8601	Start time Note: This field may return null, indicating that no valid values can be obtained.
EndTime	Timestamp ISO8601	End time Note: This field may return null, indicating that no valid values can be obtained.

Filter

Description key-value pair filter, which is used for conditional filtering queries.

If there are multiple Filters, the logical relationship between them is AND.
If there are multiple Values in the same Filter, the logical relationship between the Values under the same Filter is OR.

Used by actions: DescribeEnvironments, DescribeRunGroups, DescribeRuns, DescribeTables, DescribeTablesRows, DescribeVolumes.

Name	Type	Required	Description
Name	String	Yes	Filtering fields
Values	Array of String	Yes	Filtering field values

GitInfo

Git information

Used by actions: RunWorkflow.

Name	Type	Required	Description
GitHttpPath	String	Yes	Git URL
GitUserName	String	No	Git username .
GitTokenOrPassword	String	No	Git password or Token
Branch	String	No	Branch
Tag	String	No	Tag

LimitRange

Resource limit scope

Used by actions: CreateEnvironment.

Name	Type	Required	Description
MaxCPU	String	No	Maximum CPU setting Note: This field may return null, indicating that no valid values can be obtained.
MaxMemory	String	No	Maximum memory setting (unit: Mi, Gi, Ti, M, G, and T) Note: This field may return null, indicating that no valid values can be obtained.

NFOption

Nextflow option

Used by actions: DescribeRunGroups, RetryRuns, RunApplication, RunWorkflow.

Name	Type	Required	Description
Config	String	No	Config. Note: This field may return null, indicating that no valid values can be obtained.
Profile	String	No	Profile. Note: This field may return null, indicating that no valid values can be obtained.
Report	Boolean	No	Report. Note: This field may return null, indicating that no valid values can be obtained.
Resume	Boolean	No	Resume. Note: This field may return null, indicating that no valid values can be obtained.
NFVersion	String	No	Nextflow engine version. Valid values: - 22.10.4 - 22.10.8 - 23.10.1 Note: This field may return null, indicating that no valid values can be obtained.

ResourceIds

Cloud resource ID

Used by actions: DescribeEnvironments.

Name	Type	Description
VPCId	String	VPC ID Note: This field may return null, indicating that no valid values can be obtained.
SubnetId	String	Subnet ID Note: This field may return null, indicating that no valid values can be obtained.
SecurityGroupId	String	Security group ID Note: This field may return null, indicating that no valid values can be obtained.
TDSQLCId	String	TDSQL-C for MySQL database ID Note: This field may return null, indicating that no valid values can be obtained.
CFSId	String	CFS ID. Note: This field may return null, indicating that no valid values can be obtained.
CFSStorageType	String	CFS type. Valid values: - SD: standard - HP: high-performance - TB: standard Turbo - TP: high-performance Turbo Note: This field may return null, indicating that no valid values can be obtained.
CVMId	String	Cloud Virtual Machine ID. Note: This field may return null, indicating that no valid values can be obtained.
EKSId	String	Elastic container cluster ID Note: This field may return null, indicating that no valid values can be obtained.

ResourceQuota

Resource quota

Used by actions: CreateEnvironment.

Name	Type	Required	Description
CPULimit	String	No	CPU limit setting Note: This field may return null, indicating that no valid values can be obtained.
MemoryLimit	String	No	Memory limit setting (Unit: Mi, Gi, Ti, M, G, and T) Note: This field may return null, indicating that no valid values can be obtained.
Pods	String	No	Pod quantity setting Note: This field may return null, indicating that no valid values can be obtained.

Run

Used by actions: DescribeRuns.

Name	Type	Description
RunUuid	String	Run UUID
ProjectId	String	Project ID
ApplicationId	String	Application ID
RunGroupId	String	Run group ID
EnvironmentId	String	Environment ID
UserDefinedId	String	User-defined ID. Null for running in singleton mode. Note: This field may return null, indicating that no valid values can be obtained.
TableId	String	Table ID. Null for running in singleton mode. Note: This field may return null, indicating that no valid values can be obtained.
TableRowUuid	String	Table row UUID. Null for running in singleton mode. Note: This field may return null, indicating that no valid values can be obtained.
Status	String	Run status
Input	String	Run input
ExecutionTime	ExecutionTime	Execution time
Cache	CacheInfo	Cache information Note: This field may return null, indicating that no valid values can be obtained.
ErrorMessage	String	Error message
CreateTime	Timestamp ISO8601	Creation time
UpdateTime	Timestamp ISO8601	Update time

RunGroup

Run

Used by actions: DescribeRunGroups.

Name	Type	Description
RunGroupId	String	Run group ID
ProjectId	String	Project ID
ProjectName	String	Project name
ApplicationId	String	Application ID
ApplicationName	String	Application name
ApplicationType	String	Application type
EnvironmentId	String	Environment ID
EnvironmentName	String	Environment name
TableId	String	Table ID. Null for running in singleton mode. Note: This field may return null, indicating that no valid values can be obtained.
Name	String	Run name
Description	String	Run description
Status	String	Run status
Input	String	Run input
Option	RunOption	WDL running option
NFOption	NFOption	Nextflow running option Note: This field may return null, indicating that no valid values can be obtained.
TotalRun	Integer	Total number of runs
RunStatusCounts	Array of RunStatusCount	Number of runs in various status
ExecutionTime	ExecutionTime	Execution time
ErrorMessage	String	Error message
CreateTime	Timestamp ISO8601	Creation time
UpdateTime	Timestamp ISO8601	Update time
Creator	String	Creator Note: This field may return null, indicating that no valid values can be obtained.
CreatorId	String	Creator ID Note: This field may return null, indicating that no valid values can be obtained.
ResultNotify	String	Running result notification method Note: This field may return null, indicating that no valid values can be obtained.
ApplicationVersion	ApplicationVersion	Application version Note: This field may return null, indicating that no valid values can be obtained.

RunMetadata

Run job details

Used by actions: GetRunCalls, GetRunStatus.

Name	Type	Description
RunType	String	Run type Note: This field may return null, indicating that no valid values can be obtained.
RunId	String	Run ID Note: This field may return null, indicating that no valid values can be obtained.
ParentId	String	Parent layer ID Note: This field may return null, indicating that no valid values can be obtained.
JobId	String	Job ID Note: This field may return null, indicating that no valid values can be obtained.
CallName	String	Job name Note: This field may return null, indicating that no valid values can be obtained.
ScatterIndex	String	Scatter index Note: This field may return null, indicating that no valid values can be obtained.
Input	String	Input Note: This field may return null, indicating that no valid values can be obtained.
Output	String	Output Note: This field may return null, indicating that no valid values can be obtained.
Status	String	Status Note: This field may return null, indicating that no valid values can be obtained.
ErrorMessage	String	Error message Note: This field may return null, indicating that no valid values can be obtained.
StartTime	Timestamp ISO8601	Start time Note: This field may return null, indicating that no valid values can be obtained.
SubmitTime	Timestamp ISO8601	Submission time Note: This field may return null, indicating that no valid values can be obtained.
EndTime	Timestamp ISO8601	End time Note: This field may return null, indicating that no valid values can be obtained.
Command	String	Command Line Note: This field may return null, indicating that no valid values can be obtained.
Runtime	String	Runtime Note: This field may return null, indicating that no valid values can be obtained.
Preprocess	Boolean	Preprocessing Note: This field may return null, indicating that no valid values can be obtained.
PostProcess	Boolean	Post-processing Note: This field may return null, indicating that no valid values can be obtained.
CallCached	Boolean	Cache hit Note: This field may return null, indicating that no valid values can be obtained.
Stdout	String	Standard output Note: This field may return null, indicating that no valid values can be obtained.
Stderr	String	Error output Note: This field may return null, indicating that no valid values can be obtained.
Meta	String	Other information Note: This field may return null, indicating that no valid values can be obtained.

RunOption

Application running option

Used by actions: DescribeRunGroups, RetryRuns, RunApplication.

Name	Type	Required	Description
FailureMode	String	Yes	Operation failure mode. Valid values: - ContinueWhilePossible - NoNewCalls
UseCallCache	Boolean	Yes	Whether to use the Call-Caching feature.
UseErrorOnHold	Boolean	Yes	Whether to use the error suspension feature.
FinalWorkflowOutputsDir	String	No	Output archive COS path Note: This field may return null, indicating that no valid values can be obtained.
UseRelativeOutputPaths	Boolean	No	Whether to use the relative directory archive output. Note: This field may return null, indicating that no valid values can be obtained.

RunStatusCount

Run running status

Used by actions: DescribeRunGroups.

Name	Type	Description
Status	String	Status
Count	Integer	Quantity

SecurityGroupOption

Security group configuration

Used by actions: CreateEnvironment.

Name	Type	Required	Description
SecurityGroupId	String	Yes	Security group ID

StorageOption

CFS configuration

Used by actions: CreateEnvironment.

Name	Type	Required	Description
StorageType	String	Yes	CFS type. Valid values: - SD: standard - HP: high-performance - TB: standard Turbo - TP: high-performance Turbo
Zone	String	Yes	CFS availability zone
Capacity	Integer	No	CFS capacity in GiB, required for the Turbo series - Standard Turbo has a minimum capacity of 40 TiB, or 40,960 GiB; the capacity expansion step is 20 TiB, or 20,480 GiB. - High-performance Turbo has a minimum capacity of 20 TiB, or 20,480 GiB; the capacity expansion step is 10 TiB, or 10,240 GiB.

Table

Used by actions: DescribeTables.

Name	Type	Description
TableId	String	Table ID Note: This field may return null, indicating that no valid values can be obtained.
ProjectId	String	Associated project ID Note: This field may return null, indicating that no valid values can be obtained.
Name	String	Table name Note: This field may return null, indicating that no valid values can be obtained.
Description	String	Table description Note: This field may return null, indicating that no valid values can be obtained.
Columns	Array of TableColumn	Table column Note: This field may return null, indicating that no valid values can be obtained.
CreateTime	String	Creation time Note: This field may return null, indicating that no valid values can be obtained.
Creator	String	Creator Note: This field may return null, indicating that no valid values can be obtained.

TableColumn

Table column

Used by actions: DescribeTables.

Name	Type	Description
Header	String	Column name Note: This field may return null, indicating that no valid values can be obtained.
DataType	String	Column data type Note: This field may return null, indicating that no valid values can be obtained.

TableRow

Table row

Used by actions: DescribeTablesRows.

Name	Type	Description
TableRowUuid	String	Table row UUID Note: This field may return null, indicating that no valid values can be obtained.
Content	Array of String	Table row content Note: This field may return null, indicating that no valid values can be obtained.

VPCOption

VPC configuration

Used by actions: CreateEnvironment.

Name	Type	Required	Description
VPCId	String	No	VPC ID (Either VPCId or VPCCIDRBlock must be selected. If VPCId is selected, the existing VPCs will be used; if VPCCIDRBlock is selected, a new VPC will be created.)
SubnetId	String	No	Subnet ID (Either SubnetId or SubnetZone&SubnetCIDRBlock must be selected. If SubnetId is selected, the existing subnet will be used; if SubnetZone&SubnetCIDRBlock is selected, a new subnet will be created.)
SubnetZone	String	No	Subnet availability zone
VPCCIDRBlock	String	No	VPC CIDR.
SubnetCIDRBlock	String	No	Subnet CIDR

Volume

Used by actions: DescribeVolumes.

Name	Type	Description
VolumeId	String	Volume ID Note: This field may return null, indicating that no valid values can be obtained.
Name	String	Name Note: This field may return null, indicating that no valid values can be obtained.
Description	String	Description Note: This field may return null, indicating that no valid values can be obtained.
EnvironmentId	String	Environment ID Note: This field may return null, indicating that no valid values can be obtained.
Type	String	Volume type. Valid values: * SHARED: Multi-point mount shared storage Note: This field may return null, indicating that no valid values can be obtained.
Spec	String	Volume specifications. Valid values: - SD: standard - HP: high-performance - TB: standard Turbo - TP: high-performance Turbo Note: This field may return null, indicating that no valid values can be obtained.
Capacity	Integer	Volume size (GB) Note: This field may return null, indicating that no valid values can be obtained.
Usage	Integer	Volume usage (Byte) Note: This field may return null, indicating that no valid values can be obtained.
BandwidthLimit	Float	Volume throughput upper limit (MiB/s) Note: This field may return null, indicating that no valid values can be obtained.
DefaultMountPath	String	Default mount path Note: This field may return null, indicating that no valid values can be obtained.
IsDefault	Boolean	Whether it is the default volume. Note: This field may return null, indicating that no valid values can be obtained.
Status	String	Status Note: This field may return null, indicating that no valid values can be obtained.

tencent cloud

Recent Pages

Data Types

ApplicationVersion

CVMOption

CacheInfo

ClusterOption

DatabaseOption

Environment

EnvironmentConfig

ExecutionTime

Filter

GitInfo

LimitRange

NFOption

ResourceIds

ResourceQuota

Run

RunGroup

RunMetadata

RunOption

RunStatusCount

SecurityGroupOption

StorageOption

Table

TableColumn

TableRow

VPCOption

Volume

Was this page helpful?

Was this page helpful?

tencent cloud

Sign Up

Log in

Recent Pages

Data Types

ApplicationVersion

CVMOption

CacheInfo

ClusterOption

DatabaseOption

Environment

EnvironmentConfig

ExecutionTime

Filter

GitInfo

LimitRange

NFOption

ResourceIds

ResourceQuota

Run

RunGroup

RunMetadata

RunOption

RunStatusCount

SecurityGroupOption

StorageOption

Table

TableColumn

TableRow

VPCOption

Volume

Was this page helpful?

Was this page helpful?