Help & DocumentationAPIsBatch ComputeJob-related APIsTerminateJob

TerminateJob

Last updated: 2019-12-05 16:25:46

Contents：

1. API Description

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

This API is used to terminate an instance.
Termination is prohibited if an instance is in the "SUBMITTED" state and does not take effect if it is in the "SUCCEED" state.
Instance termination is an asynchronous process, and the time it takes to complete the entire process is directly proportional to the total number of tasks. The effect of terminating an instance is equivalent to performing the TerminateTaskInstance operation on all the task instances contained in the job. For more information on the specific effect and usage, see TerminateTaskInstance.

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: TerminateJob
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.
JobId Yes String Instance ID

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 Terminating a Job

Input Example

https://batch.tencentcloudapi.com/?Action=TerminateJob
&JobId=job-rybewp57
&<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.

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.TerminateOperationWithEnvId This operation is prohibited for the task instances in the specified compute environment.