调用StartWorkflow创建一个新的基因工作流。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cs:StartWorkflow | Write |
|
| 无 |
请求语法
POST /gs/workflow
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
body | object | 否 | 请求体参数 | |
workflow_type | string | 是 | 工作流类型,可选值:wgs 或 mapping。 | mapping |
service | string | 否 | SLA 类型,可选值:s、g、p。
| s |
mapping_oss_region | string | 否 | mapping oss 数据的存放 region。 | cn-hangzhou |
mapping_fastq_first_filename | string | 否 | mapping 的第一个 fastq 文件名。 | MGISEQ2000_PCR-free_NA12878_1_V100003043_L01_1.fq.gz |
mapping_fastq_second_filename | string | 否 | mapping 的第二个 fastq 文件名。 | MGISEQ2000_PCR-free_NA12878_1_V100003043_L01_2.fq.gz |
mapping_bucket_name | string | 否 | 存放 mapping 的 bucket 名称。 | gene-shenzhen |
mapping_fastq_path | string | 否 | mapping 的 fastq 文件路径。 | fastq/MGISEQ2000 |
mapping_reference_path | string | 否 | mapping 的 reference 文件位置。 | reference/hg19 |
mapping_is_mark_dup | string | 否 | 是否进行 dup。 | true |
mapping_bam_out_path | string | 否 | bam 文件输出路径。 | output/bamDirName |
mapping_bam_out_filename | string | 否 | bam 文件输出名称。 | abc.bam |
wgs_oss_region | string | 否 | wgs oss 数据的存放 region。 | cn-shenzhen |
wgs_fastq_first_filename | string | 否 | wgs 的第一个 fastq 文件名。 | MGISEQ2000_PCR-free_NA12878_1_V100003043_L01_1.fq.gz |
wgs_fastq_second_filename | string | 否 | wgs 的第二个 fastq 文件名。 | MGISEQ2000_PCR-free_NA12878_1_V100003043_L01_2.fq.gz |
wgs_bucket_name | string | 否 | 存放 wgs 的 bucket 名称。 | gene-shenzhen |
wgs_fastq_path | string | 否 | wgs 的 fastq 文件路径。 | fastq/MGISEQ2000 |
wgs_reference_path | string | 否 | wgs 的 reference 文件路径。 | reference/hg19 |
wgs_vcf_out_path | string | 否 | wgs 的 vcf 输出路径。 | output/vcf |
wgs_vcf_out_filename | string | 否 | wgs 的 vcf 输出文件名称。 | abc.vcf |
返回参数
示例
正常返回示例
JSON
格式
{
"JobName": "mapping-gpu-66xv7"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史