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.
URI
POST /v1/{project_id}/instances/batch-delete
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition The project ID. Constraints N/A Range The project ID of the account Default Value N/A |
Request 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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
instance_id_set |
No |
Array of strings |
Definition The list of instance IDs. Constraints A server ID list cannot contain more than 50 IDs. |
Response Parameters
Status code: 202
Parameter |
Type |
Description |
---|---|---|
instances |
Array of instances objects |
Definition Returned instance information. Constraints N/A |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition Instance ID. Constraints N/A Range N/A Default Value N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code. Constraints N/A Range N/A Default Value N/A |
error_msg |
String |
Definition Error message. Constraints N/A Range N/A Default Value N/A |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code. Constraints N/A Range N/A Default Value N/A |
error_msg |
String |
Definition Error message. Constraints N/A Range N/A Default Value N/A |
Status code: 429
Parameter |
Type |
Description |
---|---|---|
- |
String |
- |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code. Constraints N/A Range N/A Default Value N/A |
error_msg |
String |
Definition Error message. Constraints N/A Range N/A Default Value N/A |
Example Requests
Request For batch deleting instances
GET https://{endpoint}/v1/{project_id}/instances/batch-delete
Example Responses
Status code: 202
Instances deleted.
{ "instance_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
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot