Removing a Storage Volume
To remove a volume, use the HTTP DELETE method in the URI, with no message body:
https://<storage system>:8080/api/v1/volumes/<volume name>
Storage Volume Removal Success
A successful storage-volume removal returns the HTTP status code 200 OK.
Storage Volume Removal Errors
An error condition returns an error code as shown in Table 36 (page 48). For generic API error
codes, see Table 5 (page 17).
Table 36 Storage Volume Removal Error Codes
DescriptionHTTP CodeAPI Error
The volume does not exist.404 Not FoundNON_EXISTENT_VOL
Volume retention time has not expired.409 ConflictRETAINED
Volume has read-only child.409 ConflictHAS_RO_CHILD
Insufficient privileges.403 ForbiddenPERM_DENIED
Volume has child VV.409 ConflictHAS_CHILD
(Since WSAPI 1.2)
Volume in use by VV set, VLUN, etc.409 ConflictIN_USE
(Since WSAPI 1.2)
Querying Volume Information
Querying All Volumes
To query for storage volume information, use the HTTP GET method in the URI, with no message
body:
https://<storage system>:8080/api/v1/volumes
All-Volumes Query Success
Unless an error occurs, the response includes a message body with JSON objects total and
members. The total object is the number of objects in the members array. The members object
contains an array of zero or more JSON objects, one for each volume on the system. JSON object
members are shown in Table 37 (page 48)
Table 37 Message Body JSON Objects for Volume Query
DescriptionAPI TypeJSON TypeMember
VV identifier.int32numberid
UUID that was automatically
assigned to the volume at creation.
uuid stringstringuuid
VV namename31stringname
VV domainname31stringdomain
The provisioning for the VV.provisioningType enumnumberprovisioningType
Indicates the copy type of the VV.copyType enumnumbercopyType
48 Working with Storage Volumes
To Next Page
Loading...
Need help?
General