HP 3PAR Web Service API 1.3.1 Developer's Guide

Contents
1 Introduction.............................................................................................11
About the WSAPI....................................................................................................................11
Getting Started.......................................................................................................................11
Starting and Configuring the Server.....................................................................................11
About the SDK..................................................................................................................12
Java SDK.....................................................................................................................12
Perl SDK......................................................................................................................13
2 Accessing the WSAPI................................................................................14
Protocol and Message Format..................................................................................................15
URI Format........................................................................................................................15
HTTP Requests and Responses.............................................................................................15
Supported HTTP Methods...............................................................................................15
Client HTTP Headers......................................................................................................15
Server HTTP Headers.....................................................................................................17
Request Input.....................................................................................................................17
Required and Optional Members....................................................................................17
Null Members...............................................................................................................18
Enumerations................................................................................................................18
JSON Types and API Types.............................................................................................19
Filtering in Queries........................................................................................................20
JSON Character Encoding.............................................................................................21
HTTP Status and Error Codes...............................................................................................21
The code Member.........................................................................................................22
The desc Member.........................................................................................................37
The ref Member............................................................................................................37
HTTP Error Codes..........................................................................................................38
System Access........................................................................................................................38
Creating Credentials..........................................................................................................38
Creating a Session Key.......................................................................................................39
Using a Session Key...........................................................................................................39
Session Key Security......................................................................................................40
Multiple Session Keys.....................................................................................................40
Maximum Number of WSAPI Sessions.............................................................................40
Deleting a Session Key.......................................................................................................41
Session Key Deletion Success..........................................................................................41
Session Key Deletion Errors.............................................................................................41
3 Working with Common Provisioning Groups................................................42
CPG Enumeration and Configuration Objects.............................................................................42
CPG LDLayout JSON Objects..............................................................................................42
CPG RAIDType Enumeration................................................................................................42
CPG HA Enumeration.........................................................................................................43
CPG chunkletPosPref Enumeration........................................................................................43
CPG diskPatterns JSON Object............................................................................................43
CPG diskType Enumeration.................................................................................................44
CPG Space Usage Objects.................................................................................................45
Growth Objects.................................................................................................................45
CPG state Enumeration.......................................................................................................45
CPG DetailedState Enumeration...........................................................................................45
Creating a CPG.....................................................................................................................46
CPG Creation Success........................................................................................................47
Contents 3