HP 3PAR Web Service API 1.3.1 Developer's Guide

11 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 131 (page 135).
Table 131 JSON Objects for Overall Capacity Response
DescriptionValue RangeJSON TypeMember
Overall system capacity,
which includes a combination
See Table 132 (page 135).DeviceCapacity objectallCapacity
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 132 (page 135).
Table 132 DeviceCapacity JSON Objects
DescriptionAPI TypeJSON TypeMember
Total system capacity in
MiB.
uint64numbertotalMiB
(Since WSAPI 1.2)
See Table 133 (page
136).
AllocatedCapacity
object. See
Table 133 (page 136).
AllocatedCapacityallocated
(Since WSAPI 1.2)
Free capacity.uint64NumberfreeMiB
(Since WSAPI 1.2)
Free initialized capacity.uint64NumberfreeInitializedMiB
(Since WSAPI 1.2)
Querying Overall System Capacity 135