HP 3PAR StoreServ 7200 2-node HP 3PAR Web Service API 1.2 Developer's - Page 43

Volume Creation Success, Volume Creation Errors

Get HP 3PAR StoreServ 7200 2-node PDF manuals and user guides View all HP 3PAR StoreServ 7200 2-node manuals
Add to My Manuals
Save this manual to your list of manuals

Page 43 highlights

is the name of the volume being copied. Message Body Members When creating a snapshot volume, the message body is a JSON object with two members, action and parameters. The action member is a string with the value createSnapshot and the parameters member is a JSON object with members as described in Table 32 (page 43). When creating a snapshot volume, isCopy is set to true and name and copyofName are required. Table 32 Message Body parameters JSON Object Members for Snapshot-volume Creation Member name id comment readOnly JSON Type API Type string name31 number igint32 string print511 Boolean Boolean Ignored values None (Required) Negative values None None Description Specifies a snapshot VV name up to 31 characters in length. Specifies the ID of the volume. If not specified, the next available ID is chosen. Specifies any additional information up to 511 characters for the volume. true: Specifies that the copied volume is read-only. false: (default) The volume is read-write. expirationHours number igint32 retentionHours number igint32 Negative values Negative values Specifies the relative time from the current time that the volume will expire. Value is a positive integer and in the range of 1-43,800 hours, or 1825 days. Specifies the relative time from the current time that the volume will expire. Value is a positive integer and in the range of 1-43,800 hours, or 1825 days. Volume Creation Success A successful operation returns the HTTP status code 200 OK. There is no message body. Upon successful creation of the volume, the location portion of the response header contains the URI for the newly created volume in the following format: /api/v1/volumes/ Volume Creation Errors An error condition returns one of the errors in Table 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 Conflict Description Invalid parameter or JSON object. The volume already exists. TOO_LARGE NO_SPACE 400 Bad Request 400 Bad Request Volume size is above the architectural limit. Not enough space is currently available. NO_SNAP_CPG 409 Conflict No snapshot space is available. Creating a Storage Volume 43

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
<volume name>
is the name of the volume being copied.
Message Body Members
When creating a snapshot volume, the message body is a JSON object with two members,
action
and
parameters
.
The
action
member is a string with the value
createSnapshot
and the
parameters
member
is a JSON object with members as described in
Table 32 (page 43)
.
When creating a snapshot volume,
isCopy
is set to true and
name
and
copyofName
are required.
Table 32 Message Body
parameters
JSON Object Members for Snapshot-volume Creation
Description
Ignored values
API Type
JSON Type
Member
Specifies a snapshot VV name up to 31
characters in length.
None (Required)
name31
string
name
Specifies the ID of the volume. If not
specified, the next available ID is chosen.
Negative values
igint32
number
id
Specifies any additional information up
to 511 characters for the volume.
None
print511
string
comment
true
: Specifies that the copied volume is
read-only.
None
Boolean
Boolean
readOnly
false
: (default) The volume is read-write.
Specifies the relative time from the current
time that the volume will expire. Value is
Negative values
igint32
number
expirationHours
a positive integer and in the range of
1–43,800 hours, or 1825 days.
Specifies the relative time from the current
time that the volume will expire. Value is
Negative values
igint32
number
retentionHours
a positive integer and in the range of
1–43,800 hours, or 1825 days.
Volume Creation Success
A successful operation returns the HTTP status code
200 OK
. There is no message body.
Upon successful creation of the volume, the location portion of the response header contains the
URI for the newly created volume in the following format:
/api/v1/volumes/<volume name>
Volume Creation Errors
An error condition returns one of the errors in
Table 33 (page 43)
. For generic API error codes,
see
Table 5 (page 17)
.
Table 33 Base-volume and Snapshot-volume Creation Error Codes
Description
HTTP Code
API Error
Invalid parameter or JSON object.
400 Bad Request
INV_INPUT
The volume already exists.
409 Conflict
EXISTENT_VOL
Volume size is above the architectural
limit.
400 Bad Request
TOO_LARGE
Not enough space is currently available.
400 Bad Request
NO_SPACE
No snapshot space is available.
409 Conflict
NO_SNAP_CPG
Creating a Storage Volume
43