tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

RunWorkflow

Last updated: 2024-07-26 15:25:55

1. API Description

Domain name for API request: omics.tencentcloudapi.com.

This API is used to run the workflow.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: RunWorkflow.
Version Yes String Common Params. The value used for this API: 2022-11-28.
Region No String Common Params. This parameter is not required for this API.
Name Yes String Run group name
EnvironmentId Yes String Delivery environment ID
GitSource Yes GitInfo Workflow Git repository information
Type Yes String Workflow type

Supported type:
- NEXTFLOW
NFOption Yes NFOption Nextflow option
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
InputBase64 No String Run input JSON. Base64 encoding is required.
(Either InputBase64 or InputCosUri must be selected.)
InputCosUri No String Run input COS path
(Either InputBase64 or InputCosUri must be selected.)
CacheClearDelay No Integer Run cache cleanup time (hours). Leaving it blank or entering 0 indicates no cleanup.
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.
VolumeIds.N No Array of String Volume ID. If you leave it blank, the default volume will be used. Currently, only Nextflow is supported.

3. Output Parameters

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.

4. Example

Example1 Running the Workflow

Input Example

POST / HTTP/1.1
Host: omics.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RunWorkflow
<Common request parameters>

{
    "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": "",
        "Profile": "test"
    },
    "InputCosUri": "cos://bucket-10000/nextflow/taxprofiler/input/input.json"
}

Output Example

{
    "Response": {
        "RunGroupId": "run-greedy-cerise-swan-618086",
        "RequestId": "5c4fc8c5-d8b1-4041-8198-b4154c0ed15f"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.CosBucketNotExist The bucket 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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy