Terminates an instance.
Operation description
Instance termination mechanism and precautions:
Instance termination is an asynchronous operation. Sending a termination request does not mean that the instance stops immediately. Continuously query the instance status after the request to confirm the termination result. If external compute resources are involved, verify the actual status of the remote job.
The DataWorks instance status may not be consistent with the remote job status. For tasks that rely on external compute resources, such as MaxCompute, EMR, and SSH, DataWorks sends a termination request to the remote end through a client. Due to factors such as network exceptions and client compatibility, the DataWorks instance may be marked as failed while the remote job is still running. Therefore, you cannot determine that the remote job has terminated based solely on the DataWorks instance status. Check the corresponding compute platform and manually terminate the job if necessary to prevent the job from continuing to run or consuming additional resources.
Pay special attention to MaxCompute tasks under the shared scheduling resource group. The DataWorks shared scheduling resource group will be taken offline soon. Due to limits on component versions and compatibility, the termination instructions for some MaxCompute tasks may not take effect on the remote end. In such cases, go to MaxCompute to check the actual status of the corresponding instance. If it is still running, execute the kill operation in MaxCompute and confirm again that it has terminated.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
integer |
Yes |
The ID of the instance. You can call ListInstances to query the instance ID. |
1234 |
| ProjectEnv |
string |
Yes |
The environment of the workspace. Valid values: PROD (production environment) and DEV (development environment). Valid values:
|
PROD |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| HttpStatusCode |
integer |
The HTTP status code. |
200 |
| Data |
boolean |
The details of the result returned after the instance is stopped. |
true |
| ErrorMessage |
string |
The error message. |
The connection does not exist. |
| RequestId |
string |
The request ID. You can use this ID to locate logs and troubleshoot issues. |
E6F0DBDD-5AD**** |
| ErrorCode |
string |
The error code. |
Invalid.Tenant.ConnectionNotExists |
| Success |
boolean |
Indicates whether the call was successful. |
true |
Examples
Success response
JSON format
{
"HttpStatusCode": 200,
"Data": true,
"ErrorMessage": "The connection does not exist.",
"RequestId": "E6F0DBDD-5AD****",
"ErrorCode": "Invalid.Tenant.ConnectionNotExists",
"Success": true
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.