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

Getting Storage System and Version Information, Storage-system Query 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 79 highlights

8 Getting Storage System and Version Information This chapter describes how to get system-wide information and version information. Getting Storage System Information To query for storage system information, use the HTTP GET method in the URI, with no message body: https://:8080/api/v1/system NOTE: Getting system-wide storage-system information became available with WSAPI 1.2. Storage-system Query Success Upon a successful query for storage-system information, the HTTP code 200 OK is returned. Unless an internal server error occurs, the response includes a message body specified in Table 77 (page 79). Table 77 JSON Objects for Storage-system Query Response Member id name IPv4Addr IPv6Addr model serialNumber systemVersion JSON Type number string string string string string string totalNodes number masterNode onlineNodes clusterNodes chunkletSize totalCapacityMiB number Array of number Array of number number number allocatedCapacityMiB number freeCapacityMiB number failedCapacityMiB number location owner contact string string string API Type uint32 name31 name31 print511 name31 name31 name31 uint32 uint32 Array of uint32 Array of uint32 uint32 uint32 uint32 uint32 uint32 print511 print511 print511 Description System ID. System name. System IPv4 address. System IPv6 address. System model. System serial number. Storage system software version number. Total number of nodes in the system. Master node ID. Node IDs online. Node IDs in cluster Chunklet size. Total capacity (MiB) in the system. Allocated capacity (MiB) in the system. Free capacity (MiB) in the system. Failed capacity (MiB) in the system. Location of the system. Owner of the system. Contact of the system. Getting Storage System Information 79

  • 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
8 Getting Storage System and Version Information
This chapter describes how to get system-wide information and version information.
Getting Storage System Information
To query for storage system information, use the HTTP GET method in the URI, with no message
body:
https://
<storage system>
:8080/api/v1/system
NOTE:
Getting system-wide storage-system information became available with WSAPI 1.2.
Storage-system Query Success
Upon a successful query for storage-system information, the HTTP code
200 OK
is returned.
Unless an internal server error occurs, the response includes a message body specified in
Table 77 (page 79)
.
Table 77 JSON Objects for Storage-system Query Response
Description
API Type
JSON Type
Member
System ID.
uint32
number
id
System name.
name31
string
name
System IPv4 address.
name31
string
IPv4Addr
System IPv6 address.
print511
string
IPv6Addr
System model.
name31
string
model
System serial number.
name31
string
serialNumber
Storage system software
version number.
name31
string
systemVersion
Total number of nodes in the
system.
uint32
number
totalNodes
Master node ID.
uint32
number
masterNode
Node IDs online.
Array of uint32
Array of number
onlineNodes
Node IDs in cluster
Array of uint32
Array of number
clusterNodes
Chunklet size.
uint32
number
chunkletSize
Total capacity (MiB) in the
system.
uint32
number
totalCapacityMiB
Allocated capacity (MiB) in
the system.
uint32
number
allocatedCapacityMiB
Free capacity (MiB) in the
system.
uint32
number
freeCapacityMiB
Failed capacity (MiB) in the
system.
uint32
number
failedCapacityMiB
Location of the system.
print511
string
location
Owner of the system.
print511
string
owner
Contact of the system.
print511
string
contact
Getting Storage System Information
79