move doc sources to other location Reviewed-by: OpenTelekomCloud Bot <None>
14 KiB
Deleting ECSs
Function
This API is used to delete ECSs based on a specified ECS ID list.
You can delete a single ECS or multiple ECSs in a batch. A maximum of 1000 ECSs can be deleted in a batch.
Request
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
servers |
Yes |
Array of objects |
Specifies the ECSs to be deleted. For details, see Table 3. |
delete_publicip |
No |
Boolean |
Specifies whether to delete the EIP bound to the ECS when deleting the ECS. If you do not want to delete the EIP, the system only unbinds the EIP from the ECS and reserves the IP address. The value can be true or false.
NOTE:
If delete_publicip is not specified, the delete_on_termination value of the EIP decides whether the EIP is released when the ECS is deleted.
|
delete_volume |
No |
Boolean |
Specifies whether to delete the data disks attached to an ECS when deleting the ECS. If you set the parameter value to false, the system only detaches the disks from the ECS and reserves the disks. The default value is false.
|
Response
See Responses (Task).
Example Request
POST https://{endpoint}/v1/{project_id}/cloudservers/delete
{ "servers": [ { "id": "616fb98f-46ca-475e-917e-2563e5a8cd19" } ], "delete_publicip": false, "delete_volume": false }
Example Response
{ "job_id": "70a599e0-31e7-49b7-b260-868f441e862b" }
Or
{ "error": { "message": "request body is illegal.", "code": "Ecs.0005" } }
Returned Values
Error Codes
See Error Codes.