Restoring snapshot data

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
The following request restores a Thin Image pair by using the specified snapshot data. When the pair is restored, the data of the snapshot specified for the primary volume is overwritten.

Execution permission

Storage Administrator (Local Copy)

Request line

POST base-URL/v1/objects/snapshots/object-ID/actions/restore/invoke

Request message

Object ID

Specify the snapshotId value obtained by getting information about Thin Image pairs. You can also specify the following attributes and connect them with commas:

pvolLdevId,muNumber

Attribute

Type

Description

pvolLdevId

int

(Required) LDEV number of the P-VOL of the Thin Image pair to be restored

Specify a decimal (base 10) number equal to or greater than 0.

muNumber

int

(Required) MU number of the P-VOL of the Thin Image pair to be restored

Specify a value in the range from 0 to 1023.

Query parameters
None.
Body
{
  "parameters": {
    "autoSplit": false
  }
}

Attribute

Type

Description

autoSplit

boolean

(Optional) After a restore of the Thin Image pairs is complete, specify whether to split the pairs.
  • true: Splits the pair.
  • false: Does not split the pair.

If you specify true, the pair is split and snapshot data is stored. If you do not specify this item, false will be set.

Response message

Body
A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects.

Attribute

Description

affectedResources

URL of the restored Thin Image pair

Action template

GET base-URL/v1/objects/snapshots/object-ID/actions/restore

Status codes

The following table describes the meaning of the status code of the request for this operation. For details on other status codes, see the description on HTTP status codes.

Status codes

Message

Description

412

Precondition Failed

This object indicates that the following actions cannot run: actions specified during a restore of pairs.

Coding example

To get an action template:

curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/snapshots/100,3/actions/restore

To run the request after getting an action template:

curl -v -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/snapshots/100,3/actions/restore/invoke