Volume:Delete Volume

Search (SHIFT+S)

API Reference


Delete Volume

POST /block/volumes/{id}/deactivate

Deactivate a volume, this will move the volume to a "marked-for-delete" state after the deletion happens on the array side. The volume will be deleted from the database when all references to this volume 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.

idthe URN of a ViPR volume to delete

Query Parameters

force
type

Required Roles

  • TENANT_ADMIN

Prerequisites

These conditions must be met before calling this operation.

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

Request Payload

No Request Payload


Response Body

Volume information

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

Field Description Type Notes
<task>
<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 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>

JSON Example

Request
POST: https://192.168.0.0:4443/block/volumes/urn:storageos:Volume:20da03df-beac-4ab6-bd19-42c416f4a4d9:/deactivate.json HTTP/1.1

Content-Type: application/json
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
Response
HTTP/1.1 202 Accepted
Content-Type: application/json

{
    "link": {
        "href": "/block/volumes/urn:storageos:Volume:20da03df-beac-4ab6-bd19-42c416f4a4d9:/tasks/28cc50b4-3fb2-4f72-9cf5-62367fac4415",
        "rel": "self"
    },
    "op_id": "28cc50b4-3fb2-4f72-9cf5-62367fac4415",
    "resource": {
        "id": "urn:storageos:Volume:20da03df-beac-4ab6-bd19-42c416f4a4d9:",
        "link": {
            "href": "/block/volumes/urn:storageos:Volume:20da03df-beac-4ab6-bd19-42c416f4a4d9:",
            "rel": "self"
        },
        "name": "rpSanity-example.com-5561"
    },
    "start_time": 1380723066490,
    "state": "pending"
}
Notes: