接口请求域名： omics.intl.tencentcloudapi.com 。
运行工作流。
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：RunWorkflow。 |
| Version | 是 | String | 公共参数，本接口取值：2022-11-28。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai, ap-singapore, eu-frankfurt 。 |
| Name | 是 | String | 任务批次名称。 |
| EnvironmentId | 是 | String | 投递环境ID。 |
| GitSource | 是 | GitInfo | 工作流Git仓库信息。 |
| Type | 是 | String | 工作流类型。 支持类型： - NEXTFLOW |
| NFOption | 是 | NFOption | Nextflow选项。 |
| ProjectId | 否 | String | 项目ID。 （不填使用指定地域下的默认项目） |
| Description | 否 | String | 任务批次描述。 |
| InputBase64 | 否 | String | 任务输入JSON。需要进行base64编码。 （InputBase64和InputCosUri必选其一） |
| InputCosUri | 否 | String | 任务输入COS地址。 （InputBase64和InputCosUri必选其一） |
| CacheClearDelay | 否 | Integer | 任务缓存清理时间（小时）。不填或0表示不清理。 |
| WorkDir | 否 | String | 工作目录，可填写指定缓存卷内的绝对路径，不填使用默认缓存卷内的默认路径，暂时仅支持Nextflow。 |
| VolumeIds.N | 否 | Array of String | 缓存卷ID，不填使用默认缓存卷，暂时仅支持Nextflow。 |
| Entrypoint | 否 | String | 工作流入口文件，不填使用默认入口文件。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RunGroupId | String | 任务批次ID。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: omics.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RunWorkflow
<公共请求参数>
{
"ProjectId": "prj-zealous-black-seagull-241194",
"Name": "taxprofiler",
"EnvironmentId": "env-9gapsr23",
"GitSource": {
"GitHttpPath": "https://e.coding.net/omics/test/taxprofiler.git",
"Branch": "master"
},
"Type": "NEXTFLOW",
"NFOption": {
"Config": "{\"key\": \"value\"}",
"Profile": "tencentcloud"
},
"InputCosUri": "cos://bucket-10000/nextflow/taxprofiler/input/input.json"
}
{
"Response": {
"RunGroupId": "run-greedy-cerise-swan-618086",
"RequestId": "5c4fc8c5-d8b1-4041-8198-b4154c0ed15f"
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation.VersionNotReleased | 版本未发布 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.DuplicateName | 名称重复 |
| InvalidParameterValue.EntrypointNotSet | 入口文件未指定 |
| InvalidParameterValue.EnvironmentNotAvailable | 环境不可用 |
| InvalidParameterValue.InvalidBase64Encode | Base64编码错误 |
| InvalidParameterValue.InvalidDescription | 描述错误 |
| InvalidParameterValue.InvalidInputJsonFormat | 输入JSON格式错误 |
| InvalidParameterValue.InvalidInputPlaceholder | 输入占位符错误 |
| InvalidParameterValue.InvalidName | 名称错误 |
| InvalidParameterValue.InvalidRunOption | 运行参数错误 |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.ApplicationNotExist | 应用不存在 |
| ResourceNotFound.ApplicationVersionNotExist | 应用版本不存在 |
| ResourceNotFound.CosBucketNotExist | 存储桶不存在 |
| ResourceNotFound.EnvironmentNotExist | 环境不存在 |
| ResourceNotFound.ProjectNotExist | 项目不存在 |
| ResourceNotFound.TableNotExist | 表格不存在 |
| ResourceNotFound.TableRowNotExist | 表格行不存在 |
文档反馈