Help & DocumentationAPIsBatch ComputeJob-related APIsRetryJobs

RetryJobs

Last updated: 2020-03-06 20:50:28

1. API Description

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

This API is used to retry the failing task instance in instances.
Job retry is supported only if a job is in the "FAILED" state. After the retry operation succeeds, the instance will retry the failing task instances in each task in turn according to the task dependencies specified in the "DAG". The history information of the task instances will be reset, the instances will participate in subsequent scheduling and execution as if they are run for the first time.

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

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 parameter. The value used for this API: RetryJobs.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
JobIds.N Yes Array of String List of instance IDs.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Retrying Jobs

When some task instances fail in a task, only the failing instances will be retried, and the succeeding ones will not be processed.

Input Example

https://batch.tencentcloudapi.com/?Action=RetryJobs
&JobIds.0=job-rybewp57
&JobIds.1=job-97zcl3wt
&<Common request parameter>

Output Example

{
  "Response": {
    "RequestId": "970e5a9f-2963-436c-8dad-4847360676f7"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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
InternalError Internal error
InvalidParameter.JobIdMalformed Invalid instance ID format.
ResourceNotFound.Job The specified instance does not exist.
UnsupportedOperation This operation is prohibited.