StopInstances

1. API Description

This API is used to shut down one or more elastic compute instances.

Note

• You can only perform this operation on instances whose status is RUNNING and that are not in the recycle bin.

• If the API is called successfully, the instance status will become STOPPING. After the instance is shut down, its status will become STOPPED.

• This API is an async API. A response is returned after the request is sent. However, it does not mean the shutdown has been completed. You can use DescribeInstancesStatus to query the status of the instance. If the status (instanceStatus) changes from STOPPING to STOPPED, it means that the instance has been shut down successfully. Any operations on the instances are not allowed while shutting down.

• 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 ID, you can call DescribeInstances and look for instanceId in the response. The maximum number of instances in each request is 100.
forceShutdown	No	Boolean	Whether to force shutdown. If the value is empty, a forced shutdown will be performed by default.

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.
instanceIds	Array of String	A list of instance IDs that failed to shut down.

4. Code Example

Example

Shut down instances of the specified IDs.

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

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

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

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_NOT_RUNNING	Operations on instances that are not in powered-on state are not supported.