Doc CenterSign in to zenConsole

ReleaseInstances

1. API Description

This API is used to release one or more virtual machine instances.

Note

  • This operation is irreversible. Once the operation is successful, the instance will be completely released. Please operate with caution.

  • Only operations on instances in recycle bin are supported.

  • Batch operations are supported. The maximum number of instances in each request is 100.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name
Required
Type
Description

instanceIds

Yes

Array of String

Instance ID(s).

To obtain the instance IDs, you can call DescribeInstances and look for instanceId in the response.

The maximum number of instances in each request is 100.

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

Release two instances in batches.

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

Request:
{
  "instanceIds": [
    "instanceId1",
    "instanceId2"
  ]
}

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_NOT_RECYCLED

Only operations on instances in recycle bin are supported.

Last updated