HP 3PAR Web Service API 1.3.1 Developer's Guide

the process, there is no way to report the error to the client. The only solution is to close the
connection. The client will not receive the terminating zero-length CRLF chunk at the end of
response. To help the client debug and resolve the issue, the WSAPI will send the API error
code and its description as part of the JSON payload when the error occurs. For example:
"success":false,"message":{"code":101,"desc":"Invalid cursor id for chunking"}
Since there is no zero-length CRLF chunk at the end of response, the client has the option of
handling the error either by catching the exception or by ignoring the error.
Querying a Single Volume
To query a single volume, use the HTTP GET method on the following URI:
https://<storage_system>:8080/api/v1/volumes/<volume_name>
Single-Volume Query Success
In a single-volume query, there is no need for chunking, because the data sent back to the client
is small and there is no issue with memory allocation. The WSAPI server does not use chunked
transfer encoding when the request is for a single volume or VLUN.
Unless an error occurs, the response includes a message body as specified in Table 47 (page 71).
Table 47 Members JSON Object for Single-Volume Collection Message
DescriptionAPI TypeJSON TypeMember
Volume properties.Volume Property objectobjectMembers
(Since WSAPI 1.2)
Single-Volume Query Errors
Possible errors following a single-volume query are shown in Table 48 (page 71). For generic API
error codes, see Table 5 (page 22).
Table 48 Single-Volume Query Error Codes
DescriptionHTTP CodeAPI Error
The volume does not exist.404 Not FoundNON_EXISTENT_VOL
(Since WSAPI 1.2)
Invalid character for volume name.400 Bad requestINV_INPUT_ILLEGAL_CHAR
(Since WSAPI 1.2)
Filtering Multiple WWNs in a Volume Information Query
You can filter multiple WWNs in a query for a storage volume by using the HTTP GET. Use the
following URI with no message body:
https://<storage_system>:8080/api/v1/volumes?query=”wwn==value1 OR
wwn==value2 … OR wwn==valueN”
NOTE: Only the OR operator is supported in a filtering request. The limit is approximately 150
WWNs, depending on how many spaces between blocks occur in the query.
Starting with WSAPI 1.3.1, “==” in the message body can also be “EQ”.
Querying Volume Information 71