腾讯健康组学平台运行工作流-组学平台相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： omics.tencentcloudapi.com 。

运行工作流。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：RunWorkflow。
Version	是	String	公共参数，本接口取值：2022-11-28。
Region	是	String	公共参数，详见产品支持的地域列表。
Name	是	String	任务批次名称。示例值：taxprofiler
EnvironmentId	是	String	投递环境ID。示例值：env-9gapsr23
GitSource	是	GitInfo	工作流Git仓库信息。示例值：{"GitHttpPath": "https://e.coding.net/omics/test/taxprofiler.git","Branch": "master"}
Type	是	String	工作流类型。支持类型： - NEXTFLOW 示例值：NEXTFLOW
NFOption	是	NFOption	Nextflow选项。示例值：{"Config": "","Profile": "test"}
ProjectId	否	String	项目ID。（不填使用指定地域下的默认项目）示例值：prj-zealous-black-seagull-241194
Description	否	String	任务批次描述。示例值：a demo for run workflow
InputBase64	否	String	任务输入JSON。需要进行base64编码。（InputBase64和InputCosUri必选其一）示例值：e30=
InputCosUri	否	String	任务输入COS地址。（InputBase64和InputCosUri必选其一）示例值：cos://bucket-10000/nextflow/taxprofiler/input/input.json
CacheClearDelay	否	Integer	任务缓存清理时间（小时）。不填或0表示不清理。示例值：0
WorkDir	否	String	工作目录，可填写指定缓存卷内的绝对路径，不填使用默认缓存卷内的默认路径，暂时仅支持Nextflow。示例值：/vol-3cs15ks
VolumeIds.N	否	Array of String	缓存卷ID，不填使用默认缓存卷，暂时仅支持Nextflow。示例值：["vol-3cs15ks"]
Entrypoint	否	String	工作流入口文件，不填使用默认入口文件。示例值：entry.nf

3. 输出参数

参数名称	类型	描述
RunGroupId	String	任务批次ID。示例值：run-thoughtful-red-wildboar-257787
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 运行工作流

输入示例

POST / HTTP/1.1
Host: omics.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"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
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	表格行不存在

运行工作流

本页目录：