接口请求域名： omics.intl.tencentcloudapi.com 。
运行应用。
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：RunApplication。 |
| Version | 是 | String | 公共参数，本接口取值：2022-11-28。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai, ap-singapore, eu-frankfurt 。 |
| ApplicationId | 是 | String | 应用ID。 |
| Name | 是 | String | 任务批次名称。 |
| EnvironmentId | 是 | String | 投递环境ID。 |
| ProjectId | 否 | String | 项目ID。（不填使用指定地域下的默认项目） |
| Description | 否 | String | 任务批次描述。 |
| InputCosUri | 否 | String | 任务输入COS地址。（InputBase64和InputCosUri必选其一） |
| InputBase64 | 否 | String | 任务输入JSON。需要进行base64编码。（InputBase64和InputCosUri必选其一） |
| TableId | 否 | String | 批量投递表格ID，不填表示单例投递。 |
| TableRowUuids.N | 否 | Array of String | 批量投递表格行UUID。不填表示表格全部行。 |
| CacheClearDelay | 否 | Integer | 任务缓存清理时间（小时）。不填或0表示不清理。 |
| ApplicationVersionId | 否 | String | 应用版本ID。不填表示使用当前最新版本。 |
| Option | 否 | RunOption | WDL运行选项。 |
| NFOption | 否 | NFOption | Nextflow运行选项。 |
| WorkDir | 否 | String | 工作目录，当前仅支持Nextflow。可填写指定缓存卷内的绝对路径或者COS路径，不填使用默认缓存卷内的默认路径。如果使用COS路径，NFOption中LaunchDir需填写指定缓存卷内的绝对路径作为启动路径。 |
| AccessMode | 否 | String | 访问模式，不填默认私有。取值范围 - PRIVATE：私有应用 - PUBLIC：公共应用 |
| VolumeIds.N | 否 | Array of String | 缓存卷ID，不填使用默认缓存卷，暂时仅支持Nextflow。 |
| ResultNotification | 否 | Boolean | 是否开启结果通知。 |
| TimeoutNotification | 否 | Boolean | 是否开启超时通知。 |
| TimeoutNotificationMinutes | 否 | Integer | 任务超时通知时间（单位：分钟），支持5到2880分钟。 |
| EmailForNotification.N | 否 | Array of 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: RunApplication
<公共请求参数>
{
"ApplicationId": "app-sweet-cerulean-frog-569111",
"ProjectId": "prj-peaceful-pink-bird-631828",
"Name": "test application",
"Description": "test run application",
"EnvironmentId": "env-05d0g0w2",
"InputBase64": "e30K",
"CacheClearDelay": 0,
"Option": {
"FailureMode": "NoNewCalls",
"UseCallCache": true,
"UseErrorOnHold": true
}
}
{
"Response": {
"RequestId": "2f867f15-a2a6-4d42-b6e0-6e06010782ac",
"RunGroupId": "run-ashamed-turquoise-rooster-131773"
}
}
使用表格功能批量运行应用，生成的任务批次中有多个任务。
POST / HTTP/1.1
Host: omics.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RunApplication
<公共请求参数>
{
"ApplicationId": "app-sweet-cerulean-frog-569111",
"ProjectId": "prj-peaceful-pink-bird-631828",
"Name": "test application",
"Description": "test run application",
"EnvironmentId": "env-05d0g0w2",
"InputBase64": "e30K",
"TableId": "tab-rapid-si̇lver-gerbil-971422",
"TableRowUuids": [
"df909e9b-1edf-4369-a9d4-71a733770034",
"3c5f7840-3689-44f2-b6ae-9e223b996f83"
],
"CacheClearDelay": 0,
"Option": {
"FailureMode": "NoNewCalls",
"UseCallCache": true,
"UseErrorOnHold": true
}
}
{
"Response": {
"RequestId": "2f867f15-a2a6-4d42-b6e0-6e06010782ac",
"RunGroupId": "run-ashamed-turquoise-rooster-131773"
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation.EmailCountLimitExceeded | 邮件数量超出限制 |
| FailedOperation.VersionNotReleased | 版本未发布 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.DuplicateName | 名称重复 |
| InvalidParameterValue.EntrypointNotSet | 入口文件未指定 |
| InvalidParameterValue.EnvironmentNotAvailable | 环境不可用 |
| InvalidParameterValue.InvalidBase64Encode | Base64编码错误 |
| InvalidParameterValue.InvalidDescription | 描述错误 |
| InvalidParameterValue.InvalidEmailFormat | 邮箱格式错误 |
| InvalidParameterValue.InvalidInputJsonFormat | 输入JSON格式错误 |
| InvalidParameterValue.InvalidInputPlaceholder | 输入占位符错误 |
| InvalidParameterValue.InvalidName | 名称错误 |
| InvalidParameterValue.InvalidRunOption | 运行参数错误 |
| InvalidParameterValue.InvalidTimeoutMinutes | 超时分钟数无效 |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.ApplicationNotExist | 应用不存在 |
| ResourceNotFound.ApplicationVersionNotExist | 应用版本不存在 |
| ResourceNotFound.EnvironmentNotExist | 环境不存在 |
| ResourceNotFound.ProjectNotExist | 项目不存在 |
| ResourceNotFound.TableNotExist | 表格不存在 |
| ResourceNotFound.TableRowNotExist | 表格行不存在 |
文档反馈