- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Practical Tutorial
- API
- FAQs
- Service Agreement
- Related Protocol
- Contact Us
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Practical Tutorial
- API
- FAQs
- Service Agreement
- Related Protocol
- Contact Us
RetryRuns
Last updated: 2024-07-26 15:25:59
1. API Description
Domain name for API request: omics.tencentcloudapi.com.
This API is used to retry the run.
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: RetryRuns. |
| 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. |
| ProjectId | No | String | Project ID. (If you leave it blank, the default item in the specified region will be used.) |
| RunGroupId | No | String | The run group ID that needs to be retried |
| RunUuids.N | No | Array of String | The run UUID that needs to be retried |
| WDLOption | No | RunOption | WDL running option. If you leave it blank, the retried run group running option will be used. |
| NFOption | No | NFOption | Nextflow running option. If you leave it blank, the retried run group running option will be used. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| RunGroupId | String | New run group ID Note: This field may return null, indicating that no valid values can be obtained. |
| 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 Retrying the Run Group
This example shows you how to retry the run group.
Input Example
POST / HTTP/1.1
Host: omics.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RetryRuns
<Common request parameters>
{
"ProjectId": "prj-aggressive-lime-porcupine-752427",
"RunGroupId": "run-ashamed-bleak-doggy-247963"
}
Output Example
{
"Response": {
"RequestId": "46520c37-4d28-49e1-a738-01f64ae1b06b",
"RunGroupId": "run-greedy-ecru-bonobo-459181"
}
}
Example2 Retrying a Single Run
This example shows you how to retry a single run.
Input Example
POST / HTTP/1.1
Host: omics.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RetryRuns
<Common request parameters>
{
"ProjectId": "prj-aggressive-lime-porcupine-752427",
"RunUuids": [
"7b501b32-4e42-456a-9d54-aa3c9791beb0"
]
}
Output Example
{
"Response": {
"RequestId": "e2fe59bb-21e3-45de-9289-9d22a5b1bdff",
"RunGroupId": "run-lonely-orange-dodo-410909"
}
}
Example3 Retrying the Specified Run in the Run Group
This example shows you how to retry the specified run within the run group.
Input Example
POST / HTTP/1.1
Host: omics.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RetryRuns
<Common request parameters>
{
"ProjectId": "prj-aggressive-lime-porcupine-752427",
"RunGroupId": "run-ashamed-bleak-doggy-247963",
"RunUuids": [
"7b501b32-4e42-456a-9d54-aa3c9791beb0",
"38b860fa-65d3-4adc-8000-4c0c31d2ff51"
]
}
Output Example
{
"Response": {
"RequestId": "e5dc747d-7ad2-44de-afe5-569c9a342db8",
"RunGroupId": "run-pretty-yellow-mastiff-141933"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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.RetryLimitExceeded | Retry count exceeds the upper limit. |
| FailedOperation.StatusNotSupported | Unsupported status. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue | Parameter value error. |
| InvalidParameterValue.EnvironmentNotAvailable | Environment not available. |
| OperationDenied | Operation rejected. |
| ResourceNotFound | The resource does not exist. |
| ResourceNotFound.EnvironmentNotExist | The environment does not exist. |
| ResourceNotFound.ProjectNotExist | The project does not exist. |
| ResourceNotFound.RunGroupNotExist | The run group does not exist. |
| ResourceNotFound.RunNotExist | The run does not exist. |
Yes
No
Was this page helpful?