Table 37 Message Body JSON Objects for Volume Query (continued)
DescriptionAPI TypeJSON TypeMember
exceeds the indicated percentage of
the virtual volume size.
Sets a snapshot space allocation
limit. The snapshot space of the
igint32numberssSpcAllocLimitPct
virtual volume is prevented from
growing beyond the indicated
percentage of the virtual volume size.
This field enables a user space
allocation warning. It specifies that
igint32numberusrSpcAllocWarningPct
a warning alert is generated when
the reserved user space of the TPVV
exceeds the specified percentage of
the virtual volume size.
This field sets the user space
allocation limit. The user space of the
igint32numberusrSpcAllocLimitPct
TPVV is prevented from growing
beyond the specified percentage of
the virtual volume size. After the size
is reached, any new writes to the
virtual volume will fail.
Policies used for the VV.policies objobjectpolicies
CPG name from which the user space
is allocated.
name31stringuserCPG
CPG name from which the snapshot
(Snap and Admin) space is allocated.
uint32stringsnapCPG
Comment associated with the volume.print511stringcomment
All-volumes Query Errors
Upon an unsuccessful query of all volumes, the INT_SERV_ERR might be returned. For details
about this error code, see Table 5 (page 17). For generic API error codes, see Table 5 (page 17).
Querying a Single Volume
To query a single volume, use the HTTP GET method on the following URI:
https://<storage system>:8080/api/v1/volumes/<volume name>
Single-volume Query Success
Unless an error occurs, the response includes a message body as specified in Table 38 (page 50).
Table 38 Members JSON Object for Single-volume Collection Message
DescriptionAPI TypeJSON TypeMember
Volume properties.Volume Property objectobjectMembers
(Since WSAPI 1.2)
Single-volume Query Errors
Possible errors following a single-volume query are shown in Table 39 (page 51). For generic API
error codes, see Table 5 (page 17).
50 Working with Storage Volumes