HP 3PAR Web Service API 1.3.1 Developer's Guide

/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 error occurs, the system returns one of the error codes shown in Table 21 (page 47), or a
generic error code listed in “Generic WSAPI code Member Status and Error Codes” (page 22).
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 the 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 23 (page 49). For
generic API error codes, see Table 5 (page 22).
Table 23 CPG Removal Error Codes
DescriptionHTTP CodeAPI Error
CPG not found.404 Not FoundNON_EXISTENT_CPG
The CPG cannot be removed because it is in use by
a volume.
409 ConflictIN_USE
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 CPG information, use the HTTP GET method in the URI, with no message body:
https://<storage_system>:8080/api/v1/cpgs
The body of the response is an object with total and members as described in Table 24 (page
49).
Table 24 Message Body JSON Objects for CPG Query
DescriptionAPI TypeJSON TypeMember
Number of CPG objects
returned.
int32numbertotal
CPG properties.array of CPG Property
objects
array of objectsmembers
As is the case with all collection queries, the total object is the number of objects in the collection.
The members object is a JSON array of zero or more JSON objects as shown in Table 25 (page
50).
Removing a CPG 49