Volume:Delete Volumes

Search (SHIFT+S)

API Reference


Delete Volumes

POST /block/volumes/deactivate

This API allows the user to deactivate multiple volumes in a single request. There is no restriction on the the volumes specified in the request. The volumes can reside in multiple storage pools on multiple storage systems. The response will contain a task resource for each volume to be deactivated. The volumes will be deleted from the database when all references to the volumes of type BlockSnapshot and ExportGroup are deleted. If "?force=true" is added to the path, it will force the delete of internal volumes that have the SUPPORTS_FORCE flag. NOTE: This is an asynchronous operation.


Query Parameters

force
type

Required Roles

This call has no restrictions.


Prerequisites

These conditions must be met before calling this operation.

  • Dependent volume resources such as snapshots and export groups must be deleted

Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<volume_ids>
<id> The list of volume URIs to be deleted URI 0-* Elements
</volume_ids>

Response Body

A reference to a BlockTaskList containing a list of TaskResourceRep instances specifying the task data for each volume delete task.

This is an asychronous operation that returns a task object. For information on working with tasks, see Asynchronous Operations.

Field Description Type Notes
<tasks>
<task>     0-* Elements
<op_id> The task operation id String
<resource>    
<name> The name of the resource String
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</resource>      
<tenant>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</tenant>      
<associated_resources> A list of links for associated resources
<associated_resource>     0-* Elements
<name> The name of the resource String
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</associated_resource>      
</associated_resources>
<state> The state of the task Valid values: queued = task is queued pending = task is pending ready = task succeed error = task fails suspended_error = task is suspended due to an error suspended_no_error = task is suspended due to config/request String
<allowed_operations> The allowed operations of the task String
<message> The task detail message String
<description> The description of the task String
<service_error>    
<code> The numerical code associated with the error encountered when processing a service request Integer
<description> The description of the error String
<details> Detailed information concerning the error String
</service_error>      
<start_time> The date and time of when the task was started DateTime
<end_time> The date and time of when the task ended DateTime
<progress> Integer
<workflow>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</workflow>      
<queuedStartTime> DateTime
<queueName> String
<name> The name assigned to this resource in ViPR. The resource name is set by a user and can be changed at any time. It is not a unique identifier. String
<id> An identifier that is generated by ViPR when the resource is created. The resource ID is guaranteed to be unique and immutable across all virtual data centers for all time. URI
<link> A hyperlink to the details for this resource
<creation_time> A timestamp that shows when this resource was created in ViPR DateTime
<tags> Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search.
<tag> String 0-* Elements
</tags>
<inactive> Whether or not the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ViPR database. Boolean
<global> Boolean
<remote> Boolean
<vdc>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</vdc>      
<internal> Whether or not the resource is an internal resource. Boolean
</task>      
</tasks>
Notes: