Home » HP Manuals » Storage Devices » HP 3PAR StoreServ 7450 4-node » Manual Viewer

HP 3PAR StoreServ 7450 4-node HP 3PAR Web Service API 1.2 Developer's - Page 16

Deleting a Session Key, Session Key Deletion Success, HTTP Status and Error Codes, The code Member

View all HP 3PAR StoreServ 7450 4-node manuals

Add to My Manuals
Save this manual to your list of manuals

Page 16 highlights

Host: InServ1:8008 Accept: */* X-HP3PAR-WSAPI-SessionKey: 48A70B8A8301C458037E0821 Supported JSON sub-objects for the Accept: */* header are shown in Table 1 (page 12). Deleting a Session Key When a client is finished making requests to the server it should delete the session keys it created. This frees up server resources and allows for better server performance. NOTE: Unused session keys expire automatically after fifteen minutes. To delete a session key, send a request with the HTTP DELETE method and the URI: https://:8080/api/v1/credentials/ where is the key that is returned in the process of creating a session key. For more information, see "Creating Credentials" (page 14). Session Key Deletion Success A successful session key deletion returns the HTTP status code 200 OK, without a message body. Session Key Deletion Errors An error condition returns an error object as a message body. Example To delete credentials using cURL, enter the following command (as a single line): curl -X DELETE -H "Accept: application/json" https://:8080/api/v1/credentials/1-c86aedb2e7e98b41-b06d2d50 HTTP Status and Error Codes When an operation is successful, the system returns one of the following HTTP status codes: • 200 OK • 201 Created When an operation fails, one of several HTTP status codes is returned. Also, the message body contains a JSON object with information specific to the HP 3PAR WSAPI. The JSON object contains the members code, desc, and, when relevant, ref. The code member is a number and the rest are strings. The JSON object contains the following members: The code Member Just as is the case with CLI text, the text in the desc member (see Table 5 (page 17)) is subject to change and cannot be relied upon. To avoid that problem, the WSAPI provides a reliable code for an error. The error code member is a JSON numeric type. Only codes that are defined in the table below will be returned. For applications that change behavior based on errors, only the code member should be relied on. For ease of reading documentation, a symbol is defined for each numeric code, but the symbol is not part of the API. The numeric value is the contract between client and server. The codes are described in Table 5 (page 17). Generic codes for the WSAPI are described in Table 5 (page 17). 16 Accessing the WSAPI

Section	Page
HP 3PAR Web Services API 1.2 Developer's Guide	1
Contents	3
1 Introduction	9
About the WSAPI	9
Getting Started	9
Starting and Configuring the Server	9
About the SDK	9
Java SDK	10
Perl SDK	10
2 Accessing the WSAPI	11
Overview	11
Protocol and Message Format	12
Client HTTP Headers	12
Server HTTP Headers	13
Supported HTTP Methods	14
General URI Format	14
System Access	14
Creating Credentials	14
About Multiple Session Keys	14
About Session Key Security	15
Creating a Session Key	15
Using a Session Key	15
Deleting a Session Key	16
Session Key Deletion Success	16
Session Key Deletion Errors	16
HTTP Status and Error Codes	16
The code Member	16
The desc Member	24
The ref Member	25
HTTP Error Codes	25
Request Input and Optional Members	25
Null Members	26
Enumerations	26
JSON Types and API Types	27
3 Working with Common Provisioning Groups	29
CPG Enumeration and Configuration Objects	29
CPG LDLayout JSON Objects	29
CPG RAIDType Enumeration	29
CPG HA Enumeration	30
CPG chunkletPosPref Enumeration	30
CPG diskPatterns JSON Object	30
CPG diskType Enumeration	31
CPG Space Usage Objects	32
Growth Objects	32
CPG state Enumeration	32
CPG detailedState Enumeration	32
Creating a CPG	33
CPG Creation Success	33
CPG Creation Errors	34
Modifying a CPG	34
CPG Modification Success	35
CPG Modification Errors	35
Removing a CPG	35
CPG Removal Success	35
CPG Removal Errors	35
Querying CPG Information	36
Querying All CPGs	36
CPG Query Success	37
CPG Query Errors	37
Querying a Single CPG	37
Single-CPG Query Success	37
Single-CPG Query Errors	37
4 Working with Storage Volumes	38
Volume Enumeration and Configuration Objects	38
Volume provisioningType Enumeration Types	38
Volume CopyType Enumeration Types	38
Volume state Enumeration Types	38
Volume DetailedState Enumeration Types	39
Volume policies Configuration Object	40
Volume Space Objects	40
Creating a Storage Volume	41
Creating Base Volumes	41
Creating Snapshot Volumes	42
Volume Creation Success	43
Volume Creation Errors	43
Modifying a Virtual Volume	44
Volume Modification Success	46
Volume Modification Errors	46
Removing a Storage Volume	48
Storage Volume Removal Success	48
Storage Volume Removal Errors	48
Querying Volume Information	48
Querying All Volumes	48
All-Volumes Query Success	48
All-volumes Query Errors	50
Querying a Single Volume	50
Single-volume Query Success	50
Single-volume Query Errors	50
5 Working with Hosts	52
Creating a Host	52
Host Creation Success	52
Host Creation Errors	53
Modifying a Host	54
Host Modification Success	56
Host Modification Errors	56
Removing a Host	58
Host Removal Success	58
Host Removal Errors	58
Querying Hosts	58
Host Query Success	58
Host Query Errors	62
6 Working with Ports	63
Port Configuration and Enumeration Objects	63
Querying All Ports	65
All-ports Query Success	65
All-ports Query Errors	67
Querying A Single Port	67
Single-port Query Success	67
Single-port Query Errors	67
7 Working with Virtual LUNs	68
VLUN Configuration and Enumeration Objects	68
VLUN portPos Configuration Object	68
VLUNtype Enumeration	68
VLUN multipathing Enumeration	68
VLUN failedPathPol Enumeration	69
Creating a VLUN	69
VLUN Creation Success	70
VLUN Creation Errors	70
VLUN Creation Example	71
HTTP Request	71
HTTP Response	72
Removing a VLUN	72
VLUN Removal Success	72
VLUN Removal Errors	72
VLUN Removal Example	73
HTTP Request	73
HTTP Response	73
Querying VLUNs	73
Querying All VLUNs	73
All-VLUNs Query Success	73
All-VLUNs Query Example	75
All-VLUNs Query Errors	75
Querying a Single VLUN	76
Single-VLUN Query Success	76
Single-VLUN Query Errors	77
8 Getting Storage System and Version Information	79
Getting Storage System Information	79
Storage-system Query Success	79
Storage-system Query Errors	80
Getting Version Information	80
Version Information Query Success	80
Version Information Query Errors	80
9 Querying Available Space	81
Querying Overall System Capacity	81
Overall System Capacity Success	81
Overall Available Space Query Errors	84
Querying Available Space for a CPG or LDLayout Object	84
CPG Space Query Members	84
LDLayout Object Space Query Members	84
Space Query Success	84
Space Query Errors	85
10 Support and Other Resources	86
Contacting HP	86
HP 3PAR documentation	86
Typographic conventions	89
HP 3PAR branding information	89
11 Documentation feedback	90

Match case Limit results 1 per page

Host: InServ1:8008

Accept: */*

X-HP3PAR-WSAPI-SessionKey: 48A70B8A8301C458037E0821

Supported JSON sub-objects for the

Accept: */*

header are shown in

Table 1 (page 12)

Deleting a Session Key

When a client is finished making requests to the server it should delete the session keys it created.

This frees up server resources and allows for better server performance.

NOTE:

Unused session keys expire automatically after fifteen minutes.

To delete a session key, send a request with the HTTP DELETE method and the URI:

https://

:8080/api/v1/credentials/

where

is the key that is returned in the process of creating a session key. For

more information, see

“Creating Credentials” (page 14)

Session Key Deletion Success

A successful session key deletion returns the HTTP status code

200 OK

, without a message body.

Session Key Deletion Errors

An error condition returns an error object as a message body.

Example

To delete credentials using cURL, enter the following command (as a single line):

curl -X DELETE -H "Accept: application/json" https://

<storage

system>

:8080/api/v1/credentials/1-c86aedb2e7e98b41-b06d2d50

HTTP Status and Error Codes

When an operation is successful, the system returns one of the following HTTP status codes:

•

200 OK

•

201 Created

When an operation fails, one of several HTTP status codes is returned. Also, the message body

contains a JSON object with information specific to the HP 3PAR WSAPI.

The JSON object contains the members

code

desc

, and, when relevant,

ref

. The

code

member

is a number and the rest are strings.

The JSON object contains the following members:

The

code

Member

Just as is the case with CLI text, the text in the

desc

member (see

Table 5 (page 17)

) is subject to

change and cannot be relied upon. To avoid that problem, the WSAPI provides a reliable code

for an error.

The error code member is a JSON numeric type. Only codes that are defined in the table below

will be returned.

For applications that change behavior based on errors, only the

code

member should be relied

on. For ease of reading documentation, a symbol is defined for each numeric code, but the symbol

is not part of the API. The numeric value is the contract between client and server. The codes are

described in

Table 5 (page 17)

Generic codes for the WSAPI are described in

Table 5 (page 17)

Accessing the WSAPI

HP 3PAR StoreServ 7450 4-node HP 3PAR Web Service API 1.2 Developer&#039;s - Page 16

Deleting a Session Key, Session Key Deletion Success, HTTP Status and Error Codes, The code Member

Page 16 highlights

HP 3PAR StoreServ 7450 4-node HP 3PAR Web Service API 1.2 Developer's - Page 16