HP 3PAR StoreServ 7400 2-node HP 3PAR Web Service API 1.2 Developer's - Page 81

Querying Available Space, Querying Overall System Capacity, Overall System Capacity Success

Get HP 3PAR StoreServ 7400 2-node PDF manuals and user guides View all HP 3PAR StoreServ 7400 2-node manuals
Add to My Manuals
Save this manual to your list of manuals

Page 81 highlights

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://: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 Member allCapacity JSON Type DeviceCapacity object Description Value Range Overall system capacity, See Table 82 (page 81). which includes a combination of FC, NL, and SSD device types. (Since WSAPI 1.2) FCCapacity DeviceCapacity object System capacity from FC devices only. (Since WSAPI 1.2) NLCapacity DeviceCapacity object System capacity from NL devices only. (Since WSAPI 1.2) SSDCapacity DeviceCapacity object System capacity from SSD devices only. (Since WSAPI 1.2) JSON object members for DeviceCapacity are shown in Table 82 (page 81). Table 82 DeviceCapacity JSON Objects Member totalMiB JSON Type number API Type uint64 Description Total system capacity in MiB. (Since WSAPI 1.2) allocated AllocatedCapacity AllocatedCapacity object. See Table 83 (page 82). See Table 83 (page 82). (Since WSAPI 1.2) freeMiB Number uint64 Free capacity. (Since WSAPI 1.2) freeInitializedMiB Number uint64 Free initialized capacity. (Since WSAPI 1.2) freeUninitializedMiB Number uint64 Free uninitialized capacity. Querying Overall System Capacity 81

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
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 Range
Description
JSON Type
Member
See
Table 82 (page 81)
.
Overall system capacity,
which includes a
DeviceCapacity object
allCapacity
combination of FC, NL, and
SSD device types.
(Since WSAPI 1.2)
System capacity from FC
devices only.
DeviceCapacity object
FCCapacity
(Since WSAPI 1.2)
System capacity from NL
devices only.
DeviceCapacity object
NLCapacity
(Since WSAPI 1.2)
System capacity from SSD
devices only.
DeviceCapacity object
SSDCapacity
(Since WSAPI 1.2)
JSON object members for
DeviceCapacity
are shown in
Table 82 (page 81)
.
Table 82
DeviceCapacity
JSON Objects
Description
API Type
JSON Type
Member
Total system capacity in
MiB.
uint64
number
totalMiB
(Since WSAPI 1.2)
See
Table 83 (page 82)
.
AllocatedCapacity object.
See
Table 83 (page 82)
.
AllocatedCapacity
allocated
(Since WSAPI 1.2)
Free capacity.
uint64
Number
freeMiB
(Since WSAPI 1.2)
Free initialized capacity.
uint64
Number
freeInitializedMiB
(Since WSAPI 1.2)
Free uninitialized capacity.
uint64
Number
freeUninitializedMiB
Querying Overall System Capacity
81