产品概述
产品优势
应用场景
使用限制
Domain name for API request: omics.intl.tencentcloudapi.com.
This API is used to run the application.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: RunApplication. |
| Version | Yes | String | Common Params. The value used for this API: 2022-11-28. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| ApplicationId | Yes | String | Application ID |
| Name | Yes | String | Run group name |
| EnvironmentId | Yes | String | Delivery environment ID |
| ProjectId | No | String | Project ID. (If you leave it blank, the default item in the specified region will be used.) |
| Description | No | String | Run group description |
| InputCosUri | No | String | Run input COS path. (Either InputBase64 or InputCosUri must be selected.) |
| InputBase64 | No | String | Run input JSON. Base64 encoding is required. (Either InputBase64 or InputCosUri must be selected.) |
| TableId | No | String | Batch deliver table ID. Leaving it blank indicates delivery in singleton mode. |
| TableRowUuids.N | No | Array of String | Batch deliver table row UUID. Leaving it blank indicates all rows of the table. |
| CacheClearDelay | No | Integer | Run cache cleanup time (hours). Leaving it blank or entering 0 indicates no cleanup. |
| ApplicationVersionId | No | String | Application version ID. Leaving it blank indicates that the latest version is used. |
| Option | No | RunOption | WDL running option |
| NFOption | No | NFOption | Nextflow running option |
| WorkDir | No | String | Working directory. You can fill in the absolute path in the specified volume. If you leave it blank, the default path in the default volume will be used. Currently, only Nextflow is supported. |
| AccessMode | No | String | Access mode. Leaving it blank indicates it is private by default. Valid values: - PRIVATE: Private application - PUBLIC: Public application |
| VolumeIds.N | No | Array of String | Volume ID. If you leave it blank, the default volume will be used. Currently, only Nextflow is supported. |
| Parameter Name | Type | Description |
|---|---|---|
| RunGroupId | String | Run group ID |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to run applications in singleton mode, and there is one run in the generated run group.
POST / HTTP/1.1
Host: omics.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RunApplication
<Common request parameters>
{
"ApplicationId": "app-sweet-cerulean-frog-569111",
"ProjectId": "prj-peaceful-pink-bird-631828",
"Name": "test",
"Description": "test",
"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"
}
}This example shows you how to use the table feature to run applications in batches, and there is more than one run in the generated run group.
POST / HTTP/1.1
Host: omics.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RunApplication
<Common request parameters>
{
"ApplicationId": "app-sweet-cerulean-frog-569111",
"ProjectId": "prj-peaceful-pink-bird-631828",
"Name": "test",
"Description": "test",
"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"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| FailedOperation.VersionNotReleased | Version not released. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue | Parameter value error. |
| InvalidParameterValue.DuplicateName | Duplicated name. |
| InvalidParameterValue.EntrypointNotSet | Entry file not specified. |
| InvalidParameterValue.EnvironmentNotAvailable | Environment not available. |
| InvalidParameterValue.InvalidBase64Encode | Base64 encoding error. |
| InvalidParameterValue.InvalidDescription | Incorrect description. |
| InvalidParameterValue.InvalidInputJsonFormat | Incorrect input JSON format. |
| InvalidParameterValue.InvalidInputPlaceholder | Incorrect input placeholder. |
| InvalidParameterValue.InvalidName | Incorrect name. |
| InvalidParameterValue.InvalidRunOption | Incorrect running parameters. |
| OperationDenied | Operation rejected. |
| ResourceNotFound | The resource does not exist. |
| ResourceNotFound.ApplicationNotExist | The application does not exist. |
| ResourceNotFound.ApplicationVersionNotExist | The application version does not exist. |
| ResourceNotFound.EnvironmentNotExist | The environment does not exist. |
| ResourceNotFound.ProjectNotExist | The project does not exist. |
| ResourceNotFound.TableNotExist | The table does not exist. |
| ResourceNotFound.TableRowNotExist | The table row does not exist. |
文档反馈