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.
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 |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://batch.tencentcloudapi.com/?Action=TerminateJob
&JobId=job-rybewp57
&<Common request parameters>{
"Response": {
"RequestId": "970e5a9f-2963-436c-8dad-4847360676f7"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | Unsupported operation. |
| UnsupportedOperation.TerminateOperationWithEnvId | This operation is prohibited for the task instances in the specified compute environment. |
Was this page helpful?