Deleting an Instance

Function

This API is used to delete an instance. It is an asynchronous API. You can call the ShowInstanceStatus API to query the instance status. If the status of the instance changes from shutting-down to terminated, the instance has been deleted.

Calling Method

For details, see Calling APIs.

URI

DELETE /v1/{project_id}/instances/{id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. Constraints N/A Range Project ID of the account. Default Value N/A
id	Yes	String	Definition Instance ID, which is returned in the response to the CreateInstance request. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition Requests for calling an API can be authenticated using a token. If token-based authentication is used, this parameter is mandatory and must be set to a user token. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 204

**Table 3** Response body parameters
Parameter	Type	Description
-	String

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error description.

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error description.

Status code: 429

**Table 6** Response body parameters
Parameter	Type	Description
-	String

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error description.

Example Requests

Deleting an Instance

DELETE https://{endpoint}/v1/{project_id}/instances/{id}

Example Responses

None

Status Codes

Status Code	Description
204	The request has succeeded.
400	Invalid request parameter.
401	The request is not authenticated.
429	The request is overloaded.
500	Internal server error.

Error Codes

See Error Codes.

Parent topic:iMetal Instance Management

Previous topic: Batch Changing Instance Passwords

Next topic: Changing the IP Address of an Instance

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot