Batch Deleting Instances

Function

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

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
clouddc:instance:deleteBatch	Write	-	-	-	-

URI

POST /v1/{project_id}/instances/batch-delete

**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

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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
instance_id_set	No	Array of strings	Definition The list of instance IDs. Constraints A server ID list can contain a maximum of 50 IDs.

Response Parameters

Status code: 202

**Table 4** Response body parameters
Parameter	Type	Description
instances	Array of instances objects	Definition Returned instance information. Constraints N/A

**Table 5** instances
Parameter	Type	Description
id	String	Definition Instance ID. Constraints N/A Range N/A Default Value N/A

Status code: 400

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

Status code: 401

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

Status code: 429

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

Status code: 500

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

Example Requests

Batch deleting instances

POST https://{endpoint}/v1/{project_id}/instances/batch-delete

Example Responses

Status code: 202

Instances deleted.

{
  "instances" : [ {
    "id" : "0198170e-4ca7-7ee4-89a7-fa631843920b"
  } ]
}

Status Codes

Status Code	Description
202	Instances deleted.
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: Querying the Instance List

Next topic: Querying the Instance Status

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