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 76

Querying a Single VLUN, Single-VLUN Query Success

View all HP 3PAR StoreServ 7450 4-node manuals

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

Page 76 highlights

Querying a Single VLUN To query a single VLUN, use the HTTP GET method on the following URL: https://:8080/api/v1/vluns/ where: • is the VLUN identifier returned in the location header after the VLUN was created. • format can be one of the following: ◦ ,,, ◦ ,, ◦ ,, The and fields are mandatory. The and fields are optional, but one or both of them must be specified. NOTE: The use of patterns or sets in querying volumes and hosts is not supported in WSAPI 1.2. In order to query a single instance of a VLUN object, the specific volume name and host name must be specified. Single-VLUN Query Success Upon a successful VLUN query, the HTTP code 200 OK is returned. Table 74 Message Body JSON Objects for Single-VLUN Query Response Member total JSON Type number API Type int32 Description Number of VLUN objects returned. members array of objects array of VLUN Property objects VLUN properties. (Since WSAPI 1.2 As with all collection queries, the total is the number objects in the collection. NOTE: If no VLUN is specified with the volume name, LUN, and host and/or port, a NON_EXISTENT_VLUN error is returned. The members object is a JSON array of zero or more JSON objects as listed in Table 75 (page 76). Table 75 JSON Objects for members object in Single-VLUN Query Response Member lun JSON Type number API Type int32 Description LUN ID. (Since WSAPI 1.2) volumeName string name31 Volume name. (Since WSAPI 1.2) hostname string name31 Host name. (Since WSAPI 1.2) remoteName string name31 Host WWN, or iSCSI name, or SAS addr, depending on the port type. 76 Working with Virtual LUNs

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

Querying a Single VLUN

To query a single VLUN, use the HTTP GET method on the following URL:

https://

:8080/api/v1/vluns/

where:

•

is the VLUN identifier returned in the location header after the VLUN was created.

•

format can be one of the following:

◦

◦

The

and

<lunID>

fields are mandatory. The

and

fields

are optional, but one or both of them must be specified.

NOTE:

The use of patterns or sets in querying volumes and hosts is not supported in WSAPI 1.2.

In order to query a single instance of a VLUN object, the specific volume name and host name

must be specified.

Single-VLUN Query Success

Upon a successful VLUN query, the HTTP code

200 OK

is returned.

Table 74 Message Body JSON Objects for Single-VLUN Query Response

Description

API Type

JSON Type

Member

Number of VLUN objects

returned.

int32

number

total

VLUN properties.

array of VLUN Property

objects

array of objects

members

(Since WSAPI 1.2

As with all collection queries, the total is the number objects in the collection.

NOTE:

If no VLUN is specified with the volume name, LUN, and host and/or port, a

NON_EXISTENT_VLUN

error is returned.

The

members

object is a JSON array of zero or more JSON objects as listed in

Table 75 (page

76)

Table 75 JSON Objects for

members

object in Single-VLUN Query Response

Description

API Type

JSON Type

Member

LUN ID.

int32

number

lun

(Since WSAPI 1.2)

Volume name.

name31

string

volumeName

(Since WSAPI 1.2)

Host name.

name31

string

hostname

(Since WSAPI 1.2)

Host WWN, or iSCSI name,

or SAS addr, depending on

the port type.

name31

string

remoteName

Working with Virtual LUNs

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

Querying a Single VLUN, Single-VLUN Query Success

Page 76 highlights

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