StartWorkflow - Container Service for Kubernetes - Alibaba Cloud Documentation Center

You can call the StartWorkflow operation to create a workflow.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cs:StartWorkflow	none	All Resources *	none	none

Request syntax

POST /gs/workflow HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
workflow_type	string	Yes	The type of workflow. Valid values: wgs and mapping.	mapping
service	string	No	The type of service-level agreement (SLA). Valid values: s: the silver level (S-level). It requires 1 extra minute to process every 1.5 billion base pairs beyond the limit of 90 billion base pairs. g: the gold level (G-level). It requires 1 extra minute to process every 2 billion base pairs beyond the limit of 90 billion base pairs. p: the platinum level (P-level). It requires 1 extra minute to process every 3 billion base pairs beyond the limit of 90 billion base pairs.	s
mapping_oss_region	string	No	The region where the Object Storage Service (OSS) bucket that stores the data of the mapping workflow is deployed.	cn-hangzhou
mapping_fastq_first_filename	string	No	The name of the first FASTQ file of the mapping workflow.	MGISEQ2000_PCR-free_NA12878_1_V100003043_L01_1.fq.gz
mapping_fastq_second_filename	string	No	The name of the second FASTQ file of the mapping workflow.	MGISEQ2000_PCR-free_NA12878_1_V100003043_L01_2.fq.gz
mapping_bucket_name	string	No	The name of the OSS bucket that stores the data of the mapping workflow.	gene-shenzhen
mapping_fastq_path	string	No	The path of the FASTQ files of the mapping workflow.	fastq/MGISEQ2000
mapping_reference_path	string	No	The path of the reference files of the mapping workflow.	reference/hg19
mapping_is_mark_dup	string	No	Specifies whether to mark duplicate values.	true
mapping_bam_out_path	string	No	The output path of the Binary Alignment Map (BAM) file.	output/bamDirName
mapping_bam_out_filename	string	No	The name of the output BAM file.	abc.bam
wgs_oss_region	string	No	The region where the OSS bucket that stores the data of the whole genome sequencing (WGS) workflow is deployed.	cn-shenzhen
wgs_fastq_first_filename	string	No	The name of the first FASTQ file of the WGS workflow.	MGISEQ2000_PCR-free_NA12878_1_V100003043_L01_1.fq.gz
wgs_fastq_second_filename	string	No	The name of the second FASTQ file of the WGS workflow.	MGISEQ2000_PCR-free_NA12878_1_V100003043_L01_2.fq.gz
wgs_bucket_name	string	No	The name of the OSS bucket that stores the data of the WGS workflow.	gene-shenzhen
wgs_fastq_path	string	No	The path of the FASTQ files of the WGS workflow.	fastq/MGISEQ2000
wgs_reference_path	string	No	The path of the reference files of the WGS workflow.	reference/hg19
wgs_vcf_out_path	string	No	The output path of the Variant Call Format (VCF) file.	output/vcf
wgs_vcf_out_filename	string	No	The name of the output VCF file.	abc.vcf

Response parameters

Parameter	Type	Description	Example
	object	The response body.
JobName	string	The name of the workflow.	mapping-gpu-66xv7

Examples

Sample success responses

JSONformat

{
  "JobName": "mapping-gpu-66xv7"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-06-12	The API operation is deprecated	View Change Details