9 Querying Available Space
This chapter describes querying for information about overall available space on the system, and
about querying available space based on CPG and LD layout.
Querying Overall System Capacity
Space information can be queried for the overall capacity, for a given CPG name, or for an
LDLayout object.
To query overall system capacity, use the HTTP GET method in the URI, with no message body:
https://<storage system>:8080/api/v1/capacity
Overall System Capacity Success
Unless an internal server error occurs, the response includes a message body as specified in
Table 81 (page 81).
Table 81 JSON Objects for Overall Capacity Response
Value RangeDescriptionJSON TypeMember
See Table 82 (page 81).Overall system capacity,
which includes a
DeviceCapacity objectallCapacity
combination of FC, NL, and
SSD device types.
(Since WSAPI 1.2)
System capacity from FC
devices only.
DeviceCapacity objectFCCapacity
(Since WSAPI 1.2)
System capacity from NL
devices only.
DeviceCapacity objectNLCapacity
(Since WSAPI 1.2)
System capacity from SSD
devices only.
DeviceCapacity objectSSDCapacity
(Since WSAPI 1.2)
JSON object members for DeviceCapacity are shown in Table 82 (page 81).
Table 82 DeviceCapacity JSON Objects
DescriptionAPI TypeJSON TypeMember
Total system capacity in
MiB.
uint64numbertotalMiB
(Since WSAPI 1.2)
See Table 83 (page 82).AllocatedCapacity object.
See Table 83 (page 82).
AllocatedCapacityallocated
(Since WSAPI 1.2)
Free capacity.uint64NumberfreeMiB
(Since WSAPI 1.2)
Free initialized capacity.uint64NumberfreeInitializedMiB
(Since WSAPI 1.2)
Free uninitialized capacity.uint64NumberfreeUninitializedMiB
Querying Overall System Capacity 81