HP 3PAR Web Service API 1.3.1 Developer's Guide

Promoting a Virtual Copy
To promote the changes from a virtual copy back onto the base volume, thereby overwriting the
base volume with the virtual copy, use the HTTP PUT method on the following URL:
https://<storage_system>:8080/api/vi/volumes/<virtual_copy_name>
where <virtual_copy_name> is the name of the virtual copy to be promoted. The message
body is a JSON object with members as described in Table 107 (page 117).
Table 107 JSON Object Members of the Parameter Object for Promoting a Virtual Copy
DescriptionIgnored ValuesAPI TypeJSON TypeMember
Specifies the promote
operation to be
performed.
Required field.Action EnumnumberAction
If True, the promote
operation is executed
on an online volume.
BooleanOnline
The default setting is
False.
Does not apply to
online promote
Zero and negative
numbers.
taskPriorityEnumnumberPriority
operation or to stop
promote operation.
To stop the promote virtual copy operation, see Table 39 (page 61).
Virtual Copy Promotion Success
Upon success, the HTTP code 200 OK is returned. The message body shows the task ID of the
promote operation as well as an array of links which, by default, contains an href to itself
(“self”).
For example:
{
taskid: 7650
links: [ 1 ]
- 0: {
href: "https://<server_name>:<http{s}port>/api/v1/volumes/vvsri1.rw"
rel: "self"
}
}
When a virtual copy operation is successfully stopped, the HTTP code 200 OK is returned, with
no message body.
Virtual Copy Promotion Errors
Possible errors during the creation, resynchronization, or stopping of physical copies of volumes
are shown in Table 108 (page 117).
For generic API error codes, see Table 5 (page 22).
Table 108 Virtual Copy Promotion Error Codes
DescriptionHTTP CodeAPI Error
The volume is not started.403 ForbiddenVV_NOT_STARTED
Promoting a Virtual Copy 117