HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 4
... 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...
... 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...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 7
Tables 1 Client HTTP Headers Supported by the HP 3PAR WSAPI for Requests 12 2 Server HTTP Headers in the WSAPI 13 3 Session Key Message Body Member JSON Objects 14 4 Message Body JSON Objects for Session ... Message Body parameters JSON Object Members for Snapshot-volume Creation 43 33 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 Volume Removal Error Codes 48 37 Message Body JSON Objects for Volume...
Tables 1 Client HTTP Headers Supported by the HP 3PAR WSAPI for Requests 12 2 Server HTTP Headers in the WSAPI 13 3 Session Key Message Body Member JSON Objects 14 4 Message Body JSON Objects for Session ... Message Body parameters JSON Object Members for Snapshot-volume Creation 43 33 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 Volume Removal Error Codes 48 37 Message Body JSON Objects for Volume...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 10
...programs that demonstrates creation, querying, and deleting of base entities. These examples rely on the accessor and base packages. Java SDK The Java SDK includes: • Core "storage-entity" classes representing the attributes of HP 3PAR storage system objects (hosts, ports, CPGs, volumes, ...VLUNs, etc.) and input parameters (members) for accessing the HP 3PAR storage system. • Modules with the base ...
...programs that demonstrates creation, querying, and deleting of base entities. These examples rely on the accessor and base packages. Java SDK The Java SDK includes: • Core "storage-entity" classes representing the attributes of HP 3PAR storage system objects (hosts, ports, CPGs, volumes, ...VLUNs, etc.) and input parameters (members) for accessing the HP 3PAR storage system. • Modules with the base ...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 16
...credentials/ where is the key that are strings. Session Key Deletion Errors An error condition returns an error object as is subject to change behavior based on . Only codes that is returned in the desc member (see "Creating Credentials" (page 14). The numeric value is a number and ...the rest are defined in Table 1 (page 12). Generic codes for each numeric code, but the symbol is finished making requests to the HP 3PAR WSAPI. Also, the message body contains a JSON object with CLI text, the text in the process of the API. For ease of reading documentation,...
...credentials/ where is the key that are strings. Session Key Deletion Errors An error condition returns an error object as is subject to change behavior based on . Only codes that is returned in the desc member (see "Creating Credentials" (page 14). The numeric value is a number and ...the rest are defined in Table 1 (page 12). Generic codes for each numeric code, but the symbol is finished making requests to the HP 3PAR WSAPI. Also, the message body contains a JSON object with CLI text, the text in the process of the API. For ease of reading documentation,...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 20
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 creation, when the ...NON_EXISTENT_VOL NO_SPACE 21 400 Bad Request Attempt to create VLUN with invalid port type. 22 409 Conflict The storage volume already exists. 23 404 Not Found The storage volume does not exist. 24 400 Bad Request Not enough space is still exported. 20 Accessing the ...
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 creation, when the ...NON_EXISTENT_VOL NO_SPACE 21 400 Bad Request Attempt to create VLUN with invalid port type. 22 409 Conflict The storage volume already exists. 23 404 Not Found The storage volume does not exist. 24 400 Bad Request Not enough space is still exported. 20 Accessing the ...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 38
... JSON object is associated with statically allocated snapshot space. The sections apply to manage storage volumes. 4 Working with Storage Volumes This chapter describes how to creation, modification, and query operations on storage volumes. Volume state Enumeration Types Enumeration for the base volume allocated from the base volume's snapshot space. 4 Remote volume admitted into the local...
... JSON object is associated with statically allocated snapshot space. The sections apply to manage storage volumes. 4 Working with Storage Volumes This chapter describes how to creation, modification, and query operations on storage volumes. Volume state Enumeration Types Enumeration for the base volume allocated from the base volume's snapshot space. 4 Remote volume admitted into the local...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 41
... volume user space will be found in the HP 3PAR Command Line Interface Reference or in length. Specifies any role granted the vv_create right (for base volumes) or sv_create (for snapshot volumes), can be replaced with the actual storage system's host name or IP address. Specifies... Negative values None None, except caching and system, which the snapshot space will be allocated. Specifies virtual volume policies. Creating Base Volumes To create a storage volume, use the HTTP POST method in the URI: https://:8080/api/v1/volumes NOTE: The parameter will be allocated. ...
... volume user space will be found in the HP 3PAR Command Line Interface Reference or in length. Specifies any role granted the vv_create right (for base volumes) or sv_create (for snapshot volumes), can be replaced with the actual storage system's host name or IP address. Specifies... Negative values None None, except caching and system, which the snapshot space will be allocated. Specifies virtual volume policies. Creating Base Volumes To create a storage volume, use the HTTP POST method in the URI: https://:8080/api/v1/volumes NOTE: The parameter will be allocated. ...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 42
... virtual volume will be retained. Specifies the amount of 1-43,800 hours (1825 days). Table 31 Message Body JSON Objects for Base-volume Creation (continued) Member JSON Type API Type ssSpcAllocLimitPct number igint32 tpvv Boolean Boolean Ignored Values Negative values None Description warning. true... Volumes To create a snapshot volume, use the HTTP POST method in the URI: https://:8080/api/v1/volumes/ 42 Working with Storage Volumes Sets a snapshot space allocation limit. A warning alert is generated when the reserved user space of the TPVV exceeds the specified percentage...
... virtual volume will be retained. Specifies the amount of 1-43,800 hours (1825 days). Table 31 Message Body JSON Objects for Base-volume Creation (continued) Member JSON Type API Type ssSpcAllocLimitPct number igint32 tpvv Boolean Boolean Ignored Values Negative values None Description warning. true... Volumes To create a snapshot volume, use the HTTP POST method in the URI: https://:8080/api/v1/volumes/ 42 Working with Storage Volumes Sets a snapshot space allocation limit. A warning alert is generated when the reserved user space of the TPVV exceeds the specified percentage...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 43
...volume is a positive integer and in Table 32 (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 Conflict Description Invalid parameter or JSON object. ...is a JSON object with the value createSnapshot and the parameters member is a positive integer and in Table 33 (page 43). Creating a Storage Volume 43 The action member is a string with members as described in the range of the response header contains the URI for the volume....
...volume is a positive integer and in Table 32 (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 Conflict Description Invalid parameter or JSON object. ...is a JSON object with the value createSnapshot and the parameters member is a positive integer and in Table 33 (page 43). Creating a Storage Volume 43 The action member is a string with members as described in the range of the response header contains the URI for the volume....
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 44
... values Snap space allocation warning percent. (Since WSAPI 1.2) ssSpcAllocLimitPct number igint32 Zero and negative values Snap space allocation limit percent. 44 Working with Storage Volumes Table 33 Base-volume and Snapshot-volume Creation Error Codes (continued) API Error HTTP Code Description INV_INPUT_WARN_GT_LIMIT 400 Bad Request Allocation warning level is higher than expiration...
... values Snap space allocation warning percent. (Since WSAPI 1.2) ssSpcAllocLimitPct number igint32 Zero and negative values Snap space allocation limit percent. 44 Working with Storage Volumes Table 33 Base-volume and Snapshot-volume Creation Error Codes (continued) API Error HTTP Code Description INV_INPUT_WARN_GT_LIMIT 400 Bad Request Allocation warning level is higher than expiration...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 81
... system capacity in Table 81 (page 81). Table 81 JSON Objects for information about overall available space on the system, and about querying available space based on CPG and LD layout. See Table 83 (page 82). (Since WSAPI 1.2) freeMiB Number uint64 Free capacity. (Since WSAPI 1.2) freeInitializedMiB Number uint64 Free initialized capacity...
... system capacity in Table 81 (page 81). Table 81 JSON Objects for information about overall available space on the system, and about querying available space based on CPG and LD layout. See Table 83 (page 82). (Since WSAPI 1.2) freeMiB Number uint64 Free capacity. (Since WSAPI 1.2) freeInitializedMiB Number uint64 Free initialized capacity...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 84
... for cpg Space Query Response Member LDLayoutCapacity JSON Type LDLayoutCapacity object Value Range See Table 89 (page 85). Description Capacity allocated to query space information based on the following URI: https://:8080/api/v1/spacereporter The members required to query the space information given a CPG are unused. (Since WSAPI 1.2) Overall Available...
... for cpg Space Query Response Member LDLayoutCapacity JSON Type LDLayoutCapacity object Value Range See Table 89 (page 85). Description Capacity allocated to query space information based on the following URI: https://:8080/api/v1/spacereporter The members required to query the space information given a CPG are unused. (Since WSAPI 1.2) Overall Available...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 89
...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 the "InForm OS" is now referred to as the "HP 3PAR OS." • The user interface previously referred to as the "InForm Management ... previously referred to as "3PAR" products are now referred to as directed in order to the operating system. CAUTION: Indicates that failure to follow directions could result in irreversible damage to data or to achieve a functional and supported implementation based on Monospace text •...
...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 the "InForm OS" is now referred to as the "HP 3PAR OS." • The user interface previously referred to as the "InForm Management ... previously referred to as "3PAR" products are now referred to as directed in order to the operating system. CAUTION: Indicates that failure to follow directions could result in irreversible damage to data or to achieve a functional and supported implementation based on Monospace text •...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 91
... API error, 34 space query API 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 all -volume query success response, 48 allCapacity... JSON object member overall system capacity query response, 81 allocated JSON object member overall system capacity query response, 81 AllocatedCapacity JSON object overall system capacity query response, 82 allocatedCapacityMB JSON object member for storage...
... API error, 34 space query API 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 all -volume query success response, 48 allCapacity... JSON object member overall system capacity query response, 81 allocated JSON object member overall system capacity query response, 81 AllocatedCapacity JSON object overall system capacity query response, 82 allocatedCapacityMB JSON object member for storage...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 92
...clusterId JSON object member for host query, 62 clusterName JSON object member 92 Index for host query, 62 clusterNodes JSON object member for storage-system query response, 79 clusterSoftware JSON object member for host query, 62 clusterVersion JSON object member for host query, 62 CNA enumeration ...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,...
...clusterId JSON object member for host query, 62 clusterName JSON object member 92 Index for host query, 62 clusterNodes JSON object member for storage-system query response, 79 clusterSoftware JSON object member for host query, 62 clusterVersion JSON object member for host query, 62 CNA enumeration ...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 Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 93
... 29 modifying, 34 removing, 35 single-CPG query, 37 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 modification error codes, 34, 35 success response, 35 CPG query... JSON object for snapshot-volume creation, 43 createvv CLI command, 41 CREATING enumeration 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 query, 49 creationTimeSec JSON object member for all-volumes query, 49 cURL command-line...
... 29 modifying, 34 removing, 35 single-CPG query, 37 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 modification error codes, 34, 35 success response, 35 CPG query... JSON object for snapshot-volume creation, 43 createvv CLI command, 41 CREATING enumeration 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 query, 49 creationTimeSec JSON object member for all-volumes query, 49 cURL command-line...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 95
...creation API error, 53 host modification API error, 57 EXISTENT_VOL volume creation API error, 43 expirationHours JSON object member for base-volume creation, 42 for volume modification, 44 expirationHourse JSON object member for snapshot-volume creation, 43 expirationTime8601 JSON object member..., 54 forceTearDown JSON object member, 52 FPVV, 29 FREE enumeration for port operations, 64 freeCapacityMB JSON object member for storage-system query response, 79 freeChunkletsGreaterThan JSON object member for CPG operations, 31 freeChunkletsLessThan JSON object member for CPG operations, 31...
...creation API error, 53 host modification API error, 57 EXISTENT_VOL volume creation API error, 43 expirationHours JSON object member for base-volume creation, 42 for volume modification, 44 expirationHourse JSON object member for snapshot-volume creation, 43 expirationTime8601 JSON object member..., 54 forceTearDown JSON object member, 52 FPVV, 29 FREE enumeration for port operations, 64 freeCapacityMB JSON object member for storage-system query response, 79 freeChunkletsGreaterThan JSON object member for CPG operations, 31 freeChunkletsLessThan JSON object member for CPG operations, 31...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 96
... modification, 55 hosts creating, 52 modifying, 54 querying, 58 removing, 58 hostSpeed JSON object member for host query, 60, 61 HP 3PAR Command Line Interface see CLI HP 3PAR Management Console see MC HP 3PAR storage system hostname, 14 HPUX_LEGACY enumeration for host modification, 55 HTTP error codes, 25 requests and replies, 11 HTTP client request example... method DELETE, 14 GET, 14 POST, 14 PUT, 14 HTTP POST for creating a CPG, 33 for creating a host, 52 for creating a VLUN, 69 for creating base volumes, 41 for creating snapshot volumes, 42 for modifying a host, 54
... modification, 55 hosts creating, 52 modifying, 54 querying, 58 removing, 58 hostSpeed JSON object member for host query, 60, 61 HP 3PAR Command Line Interface see CLI HP 3PAR Management Console see MC HP 3PAR storage system hostname, 14 HPUX_LEGACY enumeration for host modification, 55 HTTP error codes, 25 requests and replies, 11 HTTP client request example... method DELETE, 14 GET, 14 POST, 14 PUT, 14 HTTP POST for creating a CPG, 33 for creating a host, 52 for creating a VLUN, 69 for creating base volumes, 41 for creating snapshot volumes, 42 for modifying a host, 54
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 98
... query, 59, 60, 61 for port query, 67 IPORT enumeration for port operations, 64 IPv4Addr JSON object member for storage-system query response, 79 IPv6Addr JSON object member for storage-system query response, 79 isCopy JSON object for snapshot-volume creation, 43 ISCSI enumeration for port operations, 64 iSCSI enumeration ...code, 16 defined, 10 desc, 24 null members, 26 optional members 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 modification, 35 for CPG query, 37 for CPG space usage, 32...
... query, 59, 60, 61 for port query, 67 IPORT enumeration for port operations, 64 IPv4Addr JSON object member for storage-system query response, 79 IPv6Addr JSON object member for storage-system query response, 79 isCopy JSON object for snapshot-volume creation, 43 ISCSI enumeration for port operations, 64 iSCSI enumeration ...code, 16 defined, 10 desc, 24 null members, 26 optional members 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 modification, 35 for CPG query, 37 for CPG space usage, 32...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 100
... for CPG query, 36 JSON object member, 52 for all-volumes query, 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, 79 name31 API type, 27 NEEDS_CHECK enumeration for volume operations, 39 NEEDS_MAINT_CHECK...43 NO_SPACE CPG creation and modification API error, 34 host creation API 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 JSON object member for CPG operations, 30 nodeWWN JSON object member for ...
... for CPG query, 36 JSON object member, 52 for all-volumes query, 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, 79 name31 API type, 27 NEEDS_CHECK enumeration for volume operations, 39 NEEDS_MAINT_CHECK...43 NO_SPACE CPG creation and modification API error, 34 host creation API 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 JSON object member for CPG operations, 30 nodeWWN JSON object member for ...