TerminateTaskInstance

Last updated: 2019-07-08 20:38:16

1. API Description

API request domain name: batch.tencentcloudapi.com.

This API is used to terminate a task instance For task instances with state SUCCEED or FAILED, Batch doesn't process them. For task instances with state SUBMITTED, PENDING or RUNNABLE, Batch sets them to the FAILED state. For task instances with state STARTING, RUNNING or FAILED_INTERRUPTED, Batch terminates the CVM first and then sets them to the FAILED state, which is time-consuming. In particular, if the CVM is being created and thus cannot be terminated immediately, Batch will register a scheduled termination operation in the bypass and asynchronously terminate the CVM after it is created. For task instances with state FAILED_INTERRUPTED, the related resources and quotas will be released only after the TerminateTaskInstance operation actually succeeds. This API only supports jobs submitted to an anonymous compute environment (where ComputeEnv but not EnvId is specified for SubmitJob). For jobs submitted to a named compute environment (where EnvId but not ComputeEnv is specified for SubmitJob), the TerminateTaskInstance and TerminateJob operations are not supported.

Default API request frequency limit: 2 times/second.

2. Input Parameters

The following list of request parameters lists only the API request parameters and some common parameters. For the complete list of common parameters, see Common Request Parameters.

Parameter name Required Type Description
Action Yes String Common parameter; the value for this API: TerminateTaskInstance
Version Yes String Common parameter; the value for this API: 2017-03-12
Region Yes String Common parameters; for details, see the Region List supported by the product.
JobId Yes String Job ID
TaskName Yes String Task name
TaskInstanceIndex Yes Integer Task instance index

3. Output Parameters

Parameter name Type Description
RequestId String The unique request ID which is returned for each request. The RequestId for the current request needs to be provided when troubleshooting.

4. Examples

Example 1. Terminating a Task Instance

Input

https://batch.tencentcloudapi.com/?Action=TerminateTaskInstance
&JobId=job-rybewp57
&TaskName=A
&TaskInstanceIndex=0
&<Common request parameter>

Output

{
  "Response": {
    "RequestId": "72e9a712-1fed-4b57-be72-62e71eefd4c3"
  }
}

5. Developer Resources

It is recommended to use API 3.0 Explorer. This tool provides various capabilities such as online debugging, signature verification, SDK code generation and quick API retrieval that significantly reduce the difficulty of using cloud APIs.

Cloud API 3.0 comes with a set of complementary development tools that make it easier to call the API.

6. Error Codes

Only the error codes related to this API are listed below. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error
InvalidParameter.JobIdMalformed Invalid job ID format.
ResourceNotFound.TaskInstance The specified task instance does not exist.
UnsupportedOperation.TerminateOperationWithEnvId This operation is prohibited for the task instances in the specified compute environment.