TerminateInstance

1. API Description

This API is used to return an 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.

  • You cannot return a subscription instance using this API, which will be returned when subscription expires.

  • When this API is called, the instance will be moved to the recycle bin and be released in 24 hours if there are no other operations. You can also call ReleaseInstances to release the instance.

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

  • Operations on instances in CREATE_FAILED status will delete the instance directly. For prepaid instances, all payment amounts will be refunded.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name
Required
Type
Description

instanceId

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

Return an instance with the ID: instanceId

POST /api/v2/bmc 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 subscription instances are not supported.

403

OPERATION_DENIED_POSTPAID_PROMISE

Operations failed. Resources in commitment period.

Last updated