HP 3PAR StoreServ 7450 4-node HP 3PAR Web Service API 1.2 Developer's
HP 3PAR StoreServ 7450 4-node Manual
View all HP 3PAR StoreServ 7450 4-node manuals
Add to My Manuals
Save this manual to your list of manuals |
HP 3PAR StoreServ 7450 4-node manual content summary:
- HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 1
HP 3PAR Web Services API 1.2 Developer's Guide Abstract This guide provides instructions and reference information for the HP 3PAR Web Services API. HP Part Number: QR482-96192 Published: June 2013 Edition: First - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 2
© Copyright 2012, 2013 Hewlett-Packard Development Company, L.P. The information contained herein is subject to change without notice. The only warranties for HP products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 3
...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 - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 4
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 - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 5
Getting Storage System and Version Information 79 Getting Storage System Information 79 Storage-system Query Success 79 Storage-system Query Errors...85 10 Support and Other Resources 86 Contacting HP...86 HP 3PAR documentation...86 Typographic conventions...89 HP 3PAR branding information 89 - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 6
11 Documentation feedback 90 Index...91 6 Contents - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 7
Tables 1 Client HTTP Headers Supported by the HP 3PAR WSAPI for Requests 12 2 Server HTTP Headers in the WSAPI Base-volume and Snapshot-volume Creation Error Codes 43 34 Message Body JSON Objects for Volume Modification Request 44 35 Volume Modification Request Error Codes 46 36 Storage - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 8
Query Response 76 76 Single-VLUN Query Error Codes 77 77 JSON Objects for Storage-system Query Response 79 78 Storage-system Query Error Codes 80 79 JSON Objects for Version Information Response 80 80 Storage-system Version Query Error Codes 80 81 JSON Objects for Overall Capacity Response 81 - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 9
the WSAPI commands and a summary of the items included in the HP 3PAR Web Services API Server SDK. Starting and Configuring the Server The API server is part of the HP 3PAR OS 3.1.2 and later, and will run on the HP 3PAR StoreServ Storage. The server must be started with the startwsapi command-line - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 10
. • Example programs to illustrate the creation and query of base entities. These examples rely on the accessor and base packages. Perl SDK The Perl SDK includes: • A module with methods for accessing the HP 3PAR storage system. • Modules with mappings of the error codes and enumerated properties - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 11
JSON. The message body will be ignored for GET and DELETE operations. The WSAPI enables programmatic management of HP 3PAR storage servers. The clients access Web services at specified HTTPS locations that control the following tasks: • Gaining system access through session keys • Getting version - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 12
, must be one of the values listed in the Values column. For example: Accept: application/json; charset=UTF-8 Table 1 Client HTTP Headers Supported by the HP 3PAR WSAPI for Requests Header Accept Description The response format the client can accept. Values Required One of the following: No - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 13
Table 1 Client HTTP Headers Supported by the HP 3PAR WSAPI for Requests (continued) Header Description Values Required Value Description HP3PAR-WSAPI The HP 3PAR Web Services API Server. no-cache Disables caching by mechanisms between the Web Services API server software and client - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 14
HTTP methods currently supported by the HP 3PAR WSAPI. These Services, you must create a session key by providing a username and password. The username and password are the same that you would use to access the HP 3PAR storage server through the HP 3PAR Command Line Interface (CLI) or the HP 3PAR - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 15
users. Revealing a session key is similar to revealing a password in that an unauthorized person who obtains a session key can use it to access the storage server until the key is deleted. Creating a Session Key Except when querying the API version and when creating and deleting a session key, the - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 16
Supported and the URI: https://:8080/api/v1/credentials object with information specific to the HP 3PAR WSAPI. The JSON object contains the be relied upon. To avoid that problem, the WSAPI provides a reliable code For applications that change behavior based on errors, only the code - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 17
time limit. 8 505 HTTP Version The client request uses an Not Supported unsupported HTTP version. 9 501 NOT The resource does not IMPLEMENTED support the operation. 10 (Not used by the HP 3PAR OS.) URI_RES_NOT_FOUND PERM_DENIED NON_EXISTENT_HOST TOO_LARGE OTHER 11 404 Not Found The - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 18
API Error API Error Code HTTP Code Description SVC_UNAVAIL 31 503 Service The server has reached its Unavailable maximum number of connections. Accept header is not supported. 406 Not Acceptable The language specified in client's HTTP Accept-Language header is not supported. 404 Not Found - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 19
request body contains a sequence of characters that is invalid for the supported UTF encodings. INV_INPUT_NO_REQ 64 400 Bad Request A POST request is missing action member with an invalid value. SYS_SVC_NOT_READY 68 503 Service Services that the system Unavailable depends on in order to - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 20
available for the operation. This varies based on the following circumstances: • In volume creation, when the CPG contains insufficient space for the specified volume size. • In CPG creation, when the storage system's hardware configuration does not support the requested LD layout. • In CPG - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 21
Table 6 Operation-specific API code Member Status and Error Codes (continued) API Error API Error Code HTTP Code Description RETAINED 27 409 Conflict Volume retention time has not expired. HAS_CHILD 32 409 Conflict The virtual volume (VV) has a child VV. NO_SNAP_CPG 33 409 Conflict No - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 22
Table 6 Operation-specific API code Member Status and Error Codes (continued) API Error INV_INPUT_RETAIN_GT_EXPIRE INV_INPUT_VV_POLICY BAD_CPG_PATTERN MISSING_VLUN_EXPORT_INFO INV_INPUT_PORT_SPECIFICATION INV_INPUT_TIME EXISTENT_ID INV_INPUT_TOO_MANY_WWN_OR_iSCSI API Error Code 49 50 53 54 55 58 - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 23
on system volume. (Since WSAPI 1.2) INV_OPERATION_VV_VOLUME_NOT_DEFINED_ALL_NODES 86 409 Conflict Invalid operation. Volume is not defined on all nodes. (Since WSAPI 1.2) INV_OPERATION_VV_ONLINE_COPY_IN_PROGRESS 87 409 Conflict Invalid operation. Online copy is in progress. (Since WSAPI - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 24
The text in the desc member is subject to change between releases. HP recommends avoiding parsing the desc member and using it only for display purposes desc member for an error may change from No snap CPG specified in one storage system version to Error: The volume must have a snap CPG in another - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 25
The ref Member In the event of an error that may occur for several reasons, the ref member may specify the reason for the error. For example, if the client were to send an incorrect value for a JSON member, then the server may be able to identify which member had the incorrect value. NOTE: There are - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 26
. When writing a client in a language that provides services for serializing a class into a JSON object, it a member. Null Members The WSAPI supports properties with a value of null. Clients limited values. For example, the state property of a storage volume can be one of the following: • Normal - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 27
. Restrictions on values or format are given names that appear in the Type column in Table 7 (page 27). These API types are referenced in this guide in descriptions of JSON input and output. Table 7 API Types Type 8601 Description JSON string with time in ISO 8601 format: YYYY-MM-DDThh:mm - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 28
Table 7 API Types (continued) Type Description An empty string enclosed in quotation marks ("") represents a name with no characters. An unset name is represented in JSON as null. print511 uint32 WWN JSON string of 511 or fewer characters. JSON number restricted to a 32-bit unsigned number. - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 29
Specifies the RAID type for the logical disk. Specifies the set size in the number of chunklets. Specifies that the layout must support the failure of one port pair, one cage, or one magazine. Specifies the chunklet location preference characteristics. Specifies patterns for candidate disks - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 30
based on Table 10 (page 30). Table 10 CPG HA Enumeration Symbol PORT CAGE MAG Value 1 2 3 Description Support failure of a port. Support failure of a drive cage. Support nodes. Nodes are identified by one or more integers. Multiple nodes are separated with a single comma (1,2,3). A range of nodes - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 31
Table 12 CPG diskPatterns JSON Object (continued) Member Value Ignored values Description magList string Null Specifies one or more drive magazines. Drive magazines are identified by one or more integers. Multiple drive magazines are separated with a single comma (1,2,3). A range of - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 32
disk space, when exceeded, results in a warning alert. The auto-grow operation is limited to the specified storage amount that sets the growth limit. The growth increment, the amount of logical disk storage created on each auto-grow operation. Logical disk types to be used for this CPG. For member - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 33
CPG To create a CPG, use the HTTP POST method in the URI: https://:8080/api/v1/cpgs with message body members as shown in Table 18 (page the growth increment, in MiB, the amount of logical disk storage created on each auto-grow operation. growthLimitMiB number igint32 Negative - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 34
, not creation. NON_EXISTENT_DOMAIN 404 Not Found Domain does not exist. Modifying a CPG To modify a CPG, use the HTTP PUT method in the URI: https://:8080/api/v1/cpgs/ with message body members as shown in Table 18 (page 33) and Table 20 (page 35). 34 Working - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 35
NOTE: Any user with Super, Service, or Edit role, or any role granted the cpg_set right, can Codes" (page 17). Removing a CPG To remove a CPG, use the HTTP DELETE method in the URI: https://:8080/api/v1/cpgs/ NOTE: Any user with Super or Edit role, or any role granted the - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 36
Querying CPG Information You can query for information about all the CPGs on the storage system or for information about a single CPG. Querying All CPGs To query for object Snapshot administration usage. SDUsage object Snapshot data space usage. SAGrowth object Snapshot administration space auto - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 37
CPG This section defines API operations to query a single CPG on the storage system. To query a single CPG, use the HTTP GET method on the following URI , with no message body: https://:8080/api/vi/cpgs/ where is the CPG - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 38
. SNP PEER UNKNOWN 3 The VV is a snapshot (Type vcopy) and its space is provisioned from the base volume's snapshot space. 4 Remote volume admitted into the local storage system. 5 Unknown. Volume CopyType Enumeration Types Enumeration for the CopyType JSON object is shown in Table 26 - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 39
Table 27 Volume state Enumeration Symbol NORMAL DEGRADED FAILED Value 1 2 3 Description The virtual volume (VV) is operating normally. VV is in degraded state. VV is operating abnormally. Volume DetailedState Enumeration Types Details of the volume's state are enumerated in Table 28 (page 39). - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 40
system is enabled for write caching, read caching, and read ahead for the volume false: This indicates that the storage system is disabled for write caching, read caching, and read ahead for the volume. Volume Space Objects The volume space is specified by the following - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 41
object members are optional. The definition of members can be found in the HP 3PAR Command Line Interface Reference or in the column help for the CLI command createvv. Table 31 Message Body JSON Objects for Base-volume Creation Member name cpg sizeMiB JSON Type API Type string name31 string - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 42
Table 31 Message Body JSON Objects for Base-volume Creation (continued) Member JSON Type API Type ssSpcAllocLimitPct number igint32 tpvv Boolean Volumes To create a snapshot volume, use the HTTP POST method in the URI: https://:8080/api/v1/volumes/ 42 Working with - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 43
33 (page 43). For generic API error codes, see Table 5 (page 17). Table 33 Base-volume and Snapshot-volume Creation Error Codes API Error INV_INPUT EXISTENT_VOL HTTP Code 400 Bad Request 409 available. NO_SNAP_CPG 409 Conflict No snapshot space is available. Creating a Storage Volume 43 - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 44
Table 33 Base-volume and Snapshot-volume Creation Error Codes (continued) API Error Modifying a Virtual Volume To modify or update a volume, use the HTTP PUT method in the URI: https://:8080/api/v1/volumes/ where is the name of the volume being modified - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 45
Table 34 Message Body JSON Objects for Volume Modification Request (continued) Member JSON Type API Type Ignored Values Description (Since WSAPI 1.2) userCPG string name31 None User CPG name. (Since WSAPI 1.2) usrSpcAllocWarningPct number igint32 Zero and negative values User space - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 46
Invalid time specified. usr_cpg cannot be modified on a TPVV. (Since WSAPI 1.2) UNLICENSED_FEATURE 400 Bad Request Retention time cannot be modified on a system 46 Working with Storage Volumes - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 47
Table 35 Volume Modification Request Error Codes (continued) API Error HTTP Code CPG_NOT_IN_SAME_DOMAIN 403 Forbidden INV_OPERATION_VV_PEER_VOLUME 403 Forbidden INT_SERV_ERR INV_OPERATION_VV_SYS_VOLUME 500 Internal Server Error 403 Forbidden INV_OPERATION_VV_INTERNAL_VOLUME 403 Forbidden - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 48
condition returns an error code as shown in Table 36 (page 48). For generic API error codes, see Table 5 (page 17). Table 36 Storage Volume Removal Error Codes API Error NON_EXISTENT_VOL RETAINED HTTP Code 404 Not Found 409 Conflict Description The volume does not exist. Volume retention time has - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 49
or virtual copy of another VV, this field indicates the VV that this VV is a copy of. The ID of the VV that is the base VV (at the root of the snapshot tree) for the VV. true: Read only false: Read and write allowed. state failedStates degradedStates additionalStates adminSpace snapshotSpace - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 50
error codes, see Table 5 (page 17). Querying a Single Volume To query a single volume, use the HTTP GET method on the following URI: https://:8080/api/v1/volumes/ Single-volume Query Success Unless an error occurs, the response includes a message body as specified in - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 51
Table 39 Single-volume Query Error Codes API Error HTTP Code NON_EXISTENT_VOL 404 Not Found INV_INPUT_ILLEGAL_CHAR 400 Bad request Description Volume does not exist. (Since WSAPI 1.2) Invalid character for volume name. (Since WSAPI 1.2) Querying Volume Information 51 - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 52
apply to creation, modification, removal, and query operations on hosts. Creating a Host Create a host using the HTTP POST method. Use the following URI: https://:8080/api/v1/hosts Table 40 (page 52) shows the members that the message body can include. NOTE: Any user with Super or - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 53
/api/v1/hosts/ For example: URL: https://:8080/api/v1/hosts Post: {"name":"apitesthost","persona":5} Response: HTTP/1.1 201 Created with with the location header: /api/v1/hosts/apitesthost Host Creation Errors - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 54
Modifying a Host Modify a host using the HTTP POST method. Use the following URI: https://:8080/api/v1/hosts/ NOTE: Any user with Super or Edit role, or any role granted the host_set right, can perform this - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 55
Table 42 Message Body JSON Objects for Host Modification Request (continued) Member chapSecret JSON Type string API Type string Ignored Values Null Description The chap secret for the host or the target (Since WSAPI 1.2) chapSecretHex Boolean None If True, then chapSecret is treated as Hex. - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 56
Table 45 Host hostPersona Enumeration (continued) Symbol Value ONTAP_LEGACY 7 VMWARE 8 OPENVMS 9 Description Persona with capability of SoftInq. Persona with capability of SubLun, ALUA. Persona with capability of UARepLun, Lun0SCC. Host Modification Success Upon successful modification of - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 57
Table 46 Host Modification Error Codes (continued) API Error HTTP Code INV_INPUT_ONE_REQUIRED 400 Bad Request INV_INPUT_BAD_ENUM_VALUE 400 Bad Request INV_INPUT_MISSING_REQUIRED 400 Bad Request INV_INPUT_EXCEEDS_LENGTH 400 Bad Request INV_INPUT_ILLEGAL_CHAR 400 Bad Request EXISTENT_HOST 409 - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 58
. LUN number and persona capability conflict. Duplicate path specified. Removing a Host To remove a host, use the HTTP DELETE method. Use the following URI: https://:8080/api/v1/hosts/ NOTE: Any user with Super or Edit role, or any role granted the host_remove right, can - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 59
Table 48 Host Query JSON Objects (continued) Member JSON Type API Type FCPaths iSCSIPaths domain FCPaths iSCSIPaths string name31 descriptors Descriptors agent Agent initiatorChapName string Boolean Name223 True or False targetChapName string targetChapEnabled Boolean Name223 True - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 60
Table 49 Host descriptors JSON Objects (continued) Member JSON Type comment string Description (Since WSAPI 1.2) Any additional information for the host. (Since WSAPI 1.2) When a host object is queried, it may include an array of one or more FCPaths objects. See Table 50 (page 60). Table 50 - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 61
See Table 52 (page 61). Table 52 Host portPos Configuration JSON Objects Member node JSON Type number API Type igint32 (0 - 7) Description System node. slot number igint32 (0 - 5) PCI bus slot in the node. cardPort number igint32 (0 - 4) Port number on the FC card. agent is an optional - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 62
Table 53 Host agent JSON Objects (continued) Member JSON Type clusterName string API Type Name255 clusterSoftware clusterVersion clusterId hostId string string string string Name255 Name255 Name255 Name255 Description Name of the host cluster of which the host is a member. (Since WSAPI 1.2) - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 63
and configuration objects that are used by VLUN operations. The Inform API server configuration object portPos is defined in Table 52 (page 61). The HP 3PAR OS API server returns the port mode enumeration, as shown in Table 55 (page 63). Table 55 Port portMode Enumeration Symbol SUSPENDED Value - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 64
(Since WSAPI 1.2) Link is idle for reset. (Since WSAPI 1.2) DHCP is in progress. (Since WSAPI 1.2) Link reset is pending. (Since WSAPI 1.2) The HP 3PAR OS API server returns port connection type enumeration, as shown in Table 57 (page 64). Table 57 Port portConnType Enumeration Symbol HOST Value - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 65
) (Since WSAPI 1.2) Serial-attached SCSI. (Since WSAPI 1.2) The HP 3PAR OS API server returns port failover state enumeration as shown in Table , use the HTTP GET method in the URI, with no message body: https://:8080/api/v1/ports All-ports Query Success Unless an error occurs, the - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 66
. (Since WSAPI 1.2) members array of objects array of Port Property Storage port properties. objects (Since WSAPI 1.2) The total is the number portLinkState Enum Port link state. (Since WSAPI 1.2) nodeWWN string WWN Node WWN that is unique across all ports. (Since WSAPI 1.2) portWWN - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 67
port information for a single instance, use the HTTP GET method in the URI, with no message body, where is the port :: value: https://:8080/api/v1/ports/ Single-port Query Success Upon success, the HTTP code 200 OK is returned. Unless an internal - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 68
slot cardPort JSON Type number number number API Type igint32 igint32 igint32 Description System node (0-7). PCI bus slot in the node (0-5). Port number on the FC card (0-4). VLUNtype Enumeration This component enumerates the type of VLUNs (VLUNType) assigned in the system, as defined in Table - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 69
the HTTP POST method. Use the following URI: https://:8080/api/v1/vluns Table 68 (page 69) or m-n (m to n). To support auto lun, the fields autoLun and maxAutoLun are now supported in the message body for VLUN node number, slot number, and card port number. Creating a VLUN 69 - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 70
Table 68 Message Body JSON Objects for VLUN Template Request (continued) Member noVcn JSON Type Boolean overrideLowerPriority Boolean autoLun Boolean API Type Description Ignored Values A VLUN change None* (optional) notification (VCN) not be issued after export (-novcn). Default: False - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 71
invalid port type. EXISTENT_LUN 409 Conflict LUN already exists. INV_INPUT_PORT_SPECIFICATION 400 Bad Request Incorrect portPos specification or the node or slot or cardPort in portPos object maybe out of range. INV_INPUT_PARAM_CONFLICT 400 Bad Request OverrideLowerPriority is being specified - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 72
VLUN definition, use the HTTP DELETE method in the URI: https://:8080/api/v1/vluns/,, [,< host and port) includes the system node number, PCI bus slot number, and card port number on the FC card in the format: :: None Can - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 73
on the system. Querying All VLUNs To query for VLUN information, use the HTTP GET method in the URI. The syntax is as follows: https://:8080/api/v1/vluns All-VLUNs Query Success A successful query returns the HTTP status code 200 OK and a response body with members as shown - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 74
on port type. portPos object For more information, see "VLUN portPos JSON Objects" (page 68). System port of VLUN exported to. It includes node number, slot number, and cardPort number. VLUNtype enum For more information, see "VLUNType Enumeration" (page 68). VLUN type. WWN WWN of exported - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 75
VLUN templates or active VLUNs, including all active and template VLUNs on the storage system: HTTP Request GET /api/v1/vluns HTTP/1.1 Host: storsys1.example. "vol1.0", "hostname": "host", "remoteName": "10000000C978500E", "portPos": { "node": 0, "slot": 4, "cardPort": 1 }, "type": 4, "volumeWWN": " - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 76
single VLUN, use the HTTP GET method on the following URL: https://:8080/api/v1/vluns/ where: • 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 - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 77
(continued) Member JSON Type API Type Description (Since WSAPI 1.2) portPos object portPos object System port of VLUN exported to. It includes node number, slot number, and cardPort number. type number VLUNType enum VLUN type. (Since WSAPI 1.2) volumeWWN string WWN WWN of exported - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 78
Table 76 Single-VLUN Query Error Codes (continued) API Error HTTP Code NON_EXISTENT_VOL 404 Not found NON_EXISTENT_HOST 404 Not found INV_INPUT_PORT_SPECIFICATION 400 Bad Request INV_INPUT_ILLEGAL_CHAR 400 Bad Request INV_INPUT_EXCEEDS_RANGE 400 Bad Request Description Requested volume - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 79
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 - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 80
system. timeZone string print511 Time zone where the system is located Storage-system Query Errors Possible error codes are shown in Table 78 for identifying specific builds of versions for defect reports or support requests. Version Information Query Errors Upon an unsuccessful query for - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 81
available space on the system, and about querying available space based on CPG and LD layout. Querying Overall System Capacity Space the HTTP GET method in the URI, with no message body: https://:8080/api/v1/capacity Overall System Capacity Success Unless an internal server - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 82
Table 82 DeviceCapacity JSON Objects (continued) Member JSON Type API Type failedCapacityMiB failedCapacityMiB Number unavailableCapacityMiB Number uint64 uint64 Description (Since WSAPI 1.2) Failed capacity in MiB. (Since WSAPI 1.2) Unavailable Capacity. (Since WSAPI 1.2) AllocatedCapacity - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 83
Table 84 Volumes JSON Objects (continued) Member JSON Type CPGUserMiB number Value Range uint64 CPGUserUsedMiB number uint64 CPGUserUnusedMiB number uint64 CPGSnapshotMiB number CPGSnapshotUsedMiB number uint64 uint64 CPGSnapshotUnusedMiB number uint64 CPGAdminMiB CPGAdminUsedMiB - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 84
LDLayout object, use the HTTP POST method on the following URI: https://:8080/api/v1/spacereporter The members required to query the space information Object Space Query Members The members required to query space information based on an LDLayout object are shown in Table 88 (page - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 85
Table 87 JSON Objects for cpg Space Query Response (continued) Member JSON Type Value Range Description (Since WSAPI 1.2) Upon querying for space information based on an LDLayout object, the system will return a single JSON object. Its members are described in Table 89 (page 85). Table 88 JSON - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 86
HP 3PAR StoreServ Storage Concepts Guide Using the HP 3PAR Management Console (GUI) to configure HP 3PAR Management Console User's Guide and administer HP 3PAR storage systems Using the HP 3PAR CLI to configure and administer storage HP 3PAR Command Line Interface Administrator's systems Manual - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 87
, and detailed alert information HP 3PAR F-Class, T-Class, and StoreServ 10000 Storage Troubleshooting Guide Installing, configuring, and maintaining the HP 3PAR Policy HP 3PAR Policy Server Installation and Setup Guide Server HP 3PAR Policy Server Administration Guide HP 3PAR documentation 87 - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 88
3PAR StoreServ 7000 Storage Service Guide HP 3PAR StoreServ 7450 Storage Service Guide Troubleshooting 7200, 7400, and 7450 storage systems HP 3PAR StoreServ 7000 Storage Troubleshooting Guide HP 3PAR StoreServ 7450 Storage Troubleshooting Guide Maintaining the Service Processor HP 3PAR Service - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 89
followed as directed in order to achieve a functional and supported implementation based on testing at HP. HP 3PAR branding information • The server previously referred to as the "InServ" is now referred to as the "HP 3PAR StoreServ Storage system." • The operating system previously referred to as - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 90
documentation that meets your needs. To help us improve the documentation, send any errors, suggestions, or comments to Documentation Feedback ([email protected]). Include the document title and part number, version number, or the URL when submitting your feedback. 90 Documentation feedback - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 91
capacity query response, 82 allocatedCapacityMB JSON object member for storage-system query response, 79 ALPA_WAIT enumeration for port operations, error, 85 BAD_PORT_TYPE VLUN creation API error, 71 BASE enumeration for volume operations, 38 base volume creating, 41 baseId JSON object member for - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 92
member error codes, 16 command line interface see CLI comment JSON object member for all-volumes query, 50 for base-volume creation, 41 for host query, 60 for storage-system query response, 80 for volume modification, 44 common provisioning group see CPG CONFIG_WAIT enumeration for port operations - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 93
space query, 84 with FPVVs, 29 with TPVVs, 29 cpg JSON object member for base-volume creation, 41 for CPG space query, 84 CPG creation success response, 33 CPG for volume operations, 39 creating a CPG, 33 a host, 52 a storage volume, 41 a VLUN, 69 creationTime8601 JSON object member for all-volumes - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 94
, 85 overall capacity, 85 session key deletion, 16 single-CPG query, 37 single-port query, 67 single-VLUN query, 77 storage removal, 48 storage-system query, 80 storage-system version query, 80 VLUN creation, 70 VLUN removal, 72 volume creation, 43 volume modification, 46 ERROR_STATE enumeration for - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 95
volume creation API error, 43 expirationHours JSON object member for base-volume creation, 42 for volume modification, 44 expirationHourse JSON enumeration for port operations, 65 failedCapacityMB JSON object member for storage-system query response, 79 failedPathInterval JSON object member for all- - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 96
HP 3PAR Command Line Interface see CLI HP 3PAR Management Console see MC HP 3PAR storage session key, 16 for removing a storage volume, 48 for removing a VLUN, 72 supported, 14 HTTP GET for querying a information, 79 for querying version information, 80 supported, 14 HTTP header server, 13 HTTP - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 97
84 for querying LDLayout space, 84 supported, 14 HTTP PUT for modifying a CPG, 34 for modifying a volume, 44 supported, 14 HTTP request format, 12 for all-volumes query, 48 for base-volume creation, 41 for snapshot-volume creation, 43 for storage-system query response, 79 IDLE_FOR_RESET enumeration - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 98
, 64 IPv4Addr JSON object member for storage-system query response, 79 IPv6Addr JSON object member for storage-system query response, 79 isCopy JSON for input, 25 ref, 25 required members for input, 25 JSON objects for base-volume creation, 42 for CPG creation, 33 for CPG growth objects, 32 for CPG - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 99
query response, 74 for single-VLUN query response, 76 message body for modifying a host, 54 method HTTP, 14 minor JSON object member for storage-system version query response, 80 MISSING_VLUN_EXPORT_INFO VLUN creation API error, 71 mode JSON object member for port query, 66 model JSON object member - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 100
, 48 for base-volume creation, 41 for host query, 58, 60 for snapshot volume creation, 43 for snapshot-volume creation, 43 for storage-system query response error, 53 space query API error, 85 volume creation API error, 43 node JSON object member for host query, 61 for VLUN operations, 68 nodeList - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 101
object for VLUN template creation, 70 owner JSON object member for storage-system query response, 79 P parentId JSON object member for all volume operations, 40 JSON object member for all-volumes query, 50 for base-volume creation, 41 for volume modification, 44 PORT enumeration for CPG operations, - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 102
LDLayout object available space, 84 overall available space, 81 overall capacity, 81 storage system information, 79 version information, 80 querying overall capacity error codes, removal API error, 48 retentionHours JSON object member for base-volume creation, 42 for snapshot-volume creation, 43 for - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 103
for VLUN creation, 69 for VLUN removal, 72 for volume creation, 41 Service for CPG modification, 35 Super for CPG creation, 33 for CPG modification, 35 query, 36 security session key, 15 serialNumber JSON object member for storage-system query response, 79 Server server HTTP header, 13 server WSAPI - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 104
JSON object member for all-volumes query, 49 for base-volume creation, 41 slot JSON object member for host storage entity Java SDK classes, 10 storage system hostname, 14 storage volume removal error codes, 48 success response, 48 storage-system query error codes, 80 success response, 79 storage - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 105
89 thinly-provisioned virtual volume see TPVV timeZone JSON object member for storage-system query response, 80 TOO_LARGE VLUN creation API error, 71 33 for creating a host, 52 for creating a VLUN, 69 for creating base volumes, 41 for creating snapshot volumes, 42 for deleting a session key, 16 - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 106
80 for removing a CPG, 35 for removing a host, 58 for removing a storage volume, 48 for session key creation, 14 for successful CPG creation, 33 for successful JSON object member for all-volumes query, 50 for base-volume creation, 42 for volume modification, 45 usrSpcAllocWarningPct JSON object member - HP 3PAR StoreServ 7450 4-node | HP 3PAR Web Service API 1.2 Developer's - Page 107
vv_create permissions for, 41 VVs, 68 W warningMiB JSON object member for CPG operations, 32 warningPct JSON object for CPG query, 36 Web Services application program interface see WSAPI WSAPI accessing, 11 description, 9 hostname, 14 overview, 11 request input, 25 session key, 14 system access, 14
HP 3PAR Web Services API 1.2 Developer's
Guide
Abstract
This guide provides instructions and reference information for the HP 3PAR Web Services API.
HP Part Number: QR482-96192
Published: June 2013
Edition: First