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

Overall Available Space Query Errors, Querying Available Space for a CPG or LDLayout Object

Page 84 highlights

Table 85 System JSON Objects (continued) Member JSON Type Value Range spareUsedMiB number uint64 spareUnusedMiB number uint64 Description (Since WSAPI 1.2) The system capacity allocated to spare resources in use. (Since WSAPI 1.2) The system capacity allocated to spare resources that are unused. (Since WSAPI 1.2) Overall Available Space Query Errors Upon an unsuccessful query for overall available space, the OTHER error 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 Available Space for a CPG or LDLayout Object To query available space for a given CPG or LDLayout object, use the HTTP POST method on the following URI: https://:8080/api/v1/spacereporter The members required to query the space information given a CPG are shown in Table 86 (page 84), and for a given LDLayout object in Table 89 (page 85). CPG Space Query Members JSON objects for a CPG space query are shown in Table 86 (page 84). Table 86 JSON Objects for cpg Space Query Member cpg JSON Type string API Type name31 Description The CPG name. (Since WSAPI 1.2) LDLayout Object Space Query Members The members required to query space information based on an LDLayout object are shown in Table 88 (page 85). Space Query Success Upon a successful query for available space, the HTTP code 200 OK is returned with a message body. In response to a query for space information for a given CPG or LDLayout object, the system will return a single JSON object. Members of the CPG query response for available space are shown in Table 87 (page 84). Table 87 JSON Objects for cpg Space Query Response Member LDLayoutCapacity JSON Type LDLayoutCapacity object Value Range See Table 89 (page 85). Description Capacity allocated to a layout associated with the CPG name. 84 Querying Available Space

  • 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

Table 85
System
JSON Objects
(continued)
Description
Value Range
JSON Type
Member
(Since WSAPI 1.2)
The system capacity allocated
to spare resources in use.
uint64
number
spareUsedMiB
(Since WSAPI 1.2)
The system capacity allocated
to spare resources that are
unused.
uint64
number
spareUnusedMiB
(Since WSAPI 1.2)
Overall Available Space Query Errors
Upon an unsuccessful query for overall available space, the
OTHER
error 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 Available Space for a CPG or LDLayout Object
To query available space for a given CPG or LDLayout object, use the HTTP POST method on the
following URI:
https://
<storage system>
:8080/api/v1/spacereporter
The members required to query the space information given a
CPG
are shown in
Table 86 (page
84)
, and for a given LDLayout object in
Table 89 (page 85)
.
CPG Space Query Members
JSON objects for a CPG space query are shown in
Table 86 (page 84)
.
Table 86 JSON Objects for
cpg
Space Query
Description
API Type
JSON Type
Member
The CPG name.
name31
string
cpg
(Since WSAPI 1.2)
LDLayout Object Space Query Members
The members required to query space information based on an
LDLayout
object are shown in
Table 88 (page 85)
.
Space Query Success
Upon a successful query for available space, the HTTP code
200 OK
is returned with a message
body.
In response to a query for space information for a given CPG or LDLayout object, the system will
return a single JSON object. Members of the CPG query response for available space are shown
in
Table 87 (page 84)
.
Table 87 JSON Objects for
cpg
Space Query Response
Description
Value Range
JSON Type
Member
Capacity allocated to a
layout associated with the
CPG name.
See
Table 89 (page 85)
.
LDLayoutCapacity object
LDLayoutCapacity
84
Querying Available Space