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

CPG Modification Success, Removing a CPG, CPG Removal Success, CPG Removal Errors

Page 35 highlights

NOTE: Any user with Super, Service, or Edit role, or any role granted the cpg_set right, can perform this operation. Access to all domains is required for this operation. Table 20 CPG Modification JSON Objects Member JSON Type disableAutoGrow Boolean rmGrowthLimit Boolean rmWarningAlert Boolean newName string API Type name31 Ignored Values None None None Null Description If true, disable CPG auto grow. Default is false. If true, no auto grow limit is enforced. Default is false. If true, no warning limit is enforced. Default is false. Specifies the name of the CPG to be updated to null. CPG Modification Success Upon success, the HTTP code 200 OK is returned without a message body. The location header of the JSON response indicates the URI of the updated CPG. Upon successful modification of the CPG, the location portion of the response header contains the URI for the newly modified CPG in the following format: /api/v1/cpgs/ NOTE: The new CPG name appears if the CPG name is successfully updated. If it is not updated, then is . CPG Modification Errors If an errror occurs, the system returns one of the error codes shown in Table 19 (page 34), or a general error code listed in "Generic WSAPI code Member Status and Error 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 cpg_remove right, can perform this operation. Access to all domains is required for this operation. CPG Removal Success Upon success, the HTTP status code 200 OK is returned with no message body. CPG Removal Errors Possible errors following an attempt to remove a CPG are shown in Table 21 (page 36). For generic API error codes, see Table 5 (page 17). Removing a CPG 35

  • 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

NOTE:
Any user with Super, Service, or Edit role, or any role granted the
cpg_set
right, can
perform this operation. Access to all domains is required for this operation.
Table 20 CPG Modification JSON Objects
Description
Ignored Values
API Type
JSON Type
Member
If true, disable CPG
auto grow. Default is
false.
None
Boolean
disableAutoGrow
If true, no auto grow
limit is enforced.
Default is false.
None
Boolean
rmGrowthLimit
If true, no warning
limit is enforced.
Default is false.
None
Boolean
rmWarningAlert
Specifies the name of
the CPG to be
updated to null.
Null
name31
string
newName
CPG Modification Success
Upon success, the HTTP code
200 OK
is returned without a message body. The location header
of the JSON response indicates the URI of the updated CPG.
Upon successful modification of the CPG, the location portion of the response header contains the
URI for the newly modified CPG in the following format:
/api/v1/cpgs/<new name>
NOTE:
The new CPG name appears if the CPG name is successfully updated. If it is not updated,
then
<new name>
is
<cpg name>
.
CPG Modification Errors
If an errror occurs, the system returns one of the error codes shown in
Table 19 (page 34)
, or a
general error code listed in
“Generic WSAPI
code
Member Status and Error Codes” (page 17)
.
Removing a CPG
To remove a CPG, use the HTTP DELETE method in the URI:
https://
<storage system>
:8080/api/v1/cpgs/
<cpg name>
NOTE:
Any user with Super or Edit role, or any role granted the
cpg_remove
right, can perform
this operation. Access to all domains is required for this operation.
CPG Removal Success
Upon success, the HTTP status code
200 OK
is returned with no message body.
CPG Removal Errors
Possible errors following an attempt to remove a CPG are shown in
Table 21 (page 36)
. For
generic API error codes, see
Table 5 (page 17)
.
Removing a CPG
35