Restoring snapshot data in units of snapshot groups

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 the Thin Image pairs contained in the specified snapshot group. When the pairs are restored, the snapshot data for the primary volume is overwritten in units of the specified snapshot group.

Execution permission

Storage Administrator (Local Copy)

Request line

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

Request message

Object ID

Specify the snapshotGroupId value obtained by getting information about the snapshot groups.

Attribute

Type

Description

snapshotGroupId

string

(Required) Object ID of the snapshot group to which the Thin Image pairs to be restored belong.

Specify a character string consisting of 1 to 32 characters. The name is case sensitive.

Query parameters

None.

Body
{
  "parameters": {
    "autoSplit": false
  }
}

Attribute

Type

Description

autoSplit

boolean

(Optional) After the 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 pairs are split in units of snapshot groups 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 snapshot group

Action template

GET base-URL/v1/objects/snapshot-groups/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 in units of snapshot groups.

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/snapshot-groups/snapshotGroup/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/snapshot-groups/snapshotGroup/actions/restore/invoke