TerminateInstance

1. API Description

This API is used to return a virtual machine instance.

Note

• Use this API to return an instance that is no longer required. A pay-as-you-go instance will stop billing after it is returns.

• After the instance is returned, the undetachable disks will also be returned, including system disk and additional data disk creating along with the instance. You can call DescribeDisks and find portable in the response to see whether the disk is detachable.

• Instance in recycle bin will be shut down. Please operate with caution.

• Operations on instances in recycle bin or in stalling status are not supported.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
instanceId	Yes	String	Instance ID(s). To obtain the instance IDs, you can call DescribeInstances and look for instanceId in the response.

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. Code Example

Example

Return an instance with the ID of instanceId.

POST /api/v2/vm HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: TerminateInstance
<Common Request Params>

Request:
{
  "instanceId": "instanceId"
}

Response:
{
  "requestId": "TC1748D3E-452D-4F74-8485-7AA73718E453",
  "response": {
    "requestId": "TC1748D3E-452D-4F74-8485-7AA73718E453"
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.​

HTTP Status Code	Error Code	Description
404	INVALID_INSTANCE_NOT_FOUND	Instance does not exist.
403	OPERATION_DENIED_INSTANCE_RECYCLED	Operations on instances in recycle bin are not supported.
403	OPERATION_DENIED_INSTANCE_CREATING	Operations on instances in CREATING status are not supported.
403	OPERATION_DENIED_INSTANCE_STATUS_INSTALLING	Operations on instances in INSTALLING status are not supported.
403	OPERATION_DENIED_INSTANCE_SUBSCRIPTION	Operations on instances in subscription are not supported.
403	OPERATION_DENIED_POSTPAID_PROMISE	Operations on instances in commitment term of pay-as-you-go billing model are not supported.