Managing Thin Image pairs
Overview of Thin Image
When updating the primary volume, Thin Image stores the differential data in a Thin Image pool or an HDP pool as snapshot data. If a failure occurs in the data in the storage system, the data can be restored by using the snapshot data. A REST API client issues an API to perform operations for Thin Image.
-
When a Thin Image pair without a secondary volume is created:
If a problem occurs in the primary volume data, the primary volume can be restored by using the snapshot data. A secondary volume can be allocated later to the snapshot data when the secondary volume becomes necessary.
-
When a Thin Image pair with a secondary volume is created:
The primary volume can be restored by using the snapshot data. In addition, a copy of the primary volume from when the snapshot data was stored can be viewed from the secondary volume. The following figure shows an example of obtaining a snapshot of a Thin Image pair.
To store snapshot data, create a Thin Image pair where an LDEV or a DP volume is used as a primary volume, and a virtual volume for Thin Image or a DP volume is used as a secondary volume. If the created pair is registered to a snapshot group or a consistency group, processing can be performed by group. If a consistency group is defined, the snapshot data from when the storage system received a request can be stored for all the primary volumes in that consistency group.
You can create a cascade configuration by creating a Thin Image pair for another Thin Image pair. You can also create a clone of a Thin Image pair and use the created clone as DP volumes.
If you clone a Thin Image pair that has the clone attribute, the volume that was specified as the secondary volume can be used as a DP volume.
For details about Thin Image, see the Hitachi Thin Image User Guide.
Workflow for operating Thin Image pairs
-
Getting information about snapshot groups
Obtains a list of snapshot groups registered in the target storage system.
-
Getting pair status and configuration information
Obtains a Thin Image pair status and configuration information. You can check if a pair operation is complete. You can also obtain pair information in units of snapshot groups.
-
Creating a pair
Creates a new Thin Image pair in a snapshot group of the target storage system. If the snapshot group is not created, the snapshot group is automatically created. You will be able to perform operations in units of snapshot groups by creating Thin Image pairs in a snapshot group.
To create a pair in a new snapshot group:
To create a pair in an existing snapshot group:
When creating a pair, you can specify whether the clone attribute can be set and whether a cascade configuration is possible.
-
Storing snapshot data
Splits a Thin Image pair, and then stores snapshot data, after the primary volume is updated.
-
Resynchronizing a pair
Deletes old snapshot data by resynchronizing a pair. You can perform pair resynchronization if the pair status is PSUS. When pair resynchronization is complete, new snapshot data can be automatically stored again.
-
Recovering a pair by a restore
If you restore a split Thin Image pair, data of the primary volume is restored to the data from when the snapshot data was stored. You can also perform a restore in units of snapshot groups. You can perform a restore if the pair status is PSUS.
-
Assigning a secondary volume to snapshot data
Assigns a secondary volume to the snapshot data of the specified Thin Image pair. Create in advance a virtual volume for Thin Image to be used as the secondary volume. If you assign a secondary volume, you can view the snapshots.
-
Unallocating the secondary volume for snapshot data
Unallocates the secondary volume of the specified Thin Image pair.
-
Deleting a pair
Deletes a Thin Image pair that is unnecessary. If you delete a pair, the snapshot data is deleted from the Thin Image pool or the HDP pool. In addition, if the specified Thin Image pair is the last one in a snapshot group, the snapshot group is also deleted. You can also delete pairs in units of snapshot groups or snapshot trees.
You can delete a pair at any time regardless of the pair status. However, if you delete a pair while the pair status is being changed, the pair might be deleted before its status is changed, and the request to change the pair status might time out.
-
Cloning
After all the data of the primary volume of a Thin Image pair that has the clone attribute is copied to the secondary volume, the pair is deleted.
Pair status (Thin Image)
Pair status |
Description |
Access to the P-VOL |
Access to the S-VOL |
SMPL |
Unpaired volumes |
- |
- |
SMPP |
A pair was deleted and differential data is now being deleted# |
R/W enabled |
Not enabled |
COPY |
A pair is being created |
R/W enabled |
Not enabled |
PAIR |
Paired volumes |
R/W enabled |
Not enabled |
PFUL |
The volumes are paired, and the threshold of a Thin Image pool or an HDP pool is exceeded. |
R/W enabled |
Not enabled |
PSUS |
The pair has been split. |
R/W enabled |
R/W enabled |
PFUS |
The pair is split and the threshold of a Thin Image pool or an HDP pool is exceeded. |
R/W enabled |
R/W enabled |
RCPY |
A restore operation is being performed. (Data is being copied from the S-VOL to the P-VOL.) |
R/W enabled |
Not enabled |
PSUE |
The pairing is suspended. |
R/W enabled |
Not enabled |
#: When a pair is in the SMPP status, the volumes that made up the pair cannot be deleted.
When a Universal Replicator pair is made up of volumes with the SLU attribute, if a REST API request whose object type is snapshot-groups or snapshots is run on the pair, the CPYD status might be output. CPYD indicates the same status as PSUS, PSUP, and PFUS.
The following figure shows the pair status changes when cloning is performed.
Pair status |
Description |
Access to the P-VOL |
Access to the S-VOL |
SMPL |
Unpaired volumes |
- |
- |
SMPP |
A pair was deleted and differential data is now being deleted# |
R/W enabled |
R/W enabled |
COPY |
A pair is being created |
R/W enabled |
Not enabled |
PAIR |
Paired volumes |
R/W enabled |
Not enabled |
PSUP |
A pair is being split |
R/W enabled |
R/W enabled |
PSUE |
The pairing is suspended. |
R/W enabled |
Not enabled |
#: When a pair is in the SMPP status, the volumes that made up the pair cannot be deleted.
Getting information about Thin Image pairs in units of snapshot groups
Storage Administrator (View Only)
GET base-URL/v1/objects/snapshot-groups
Object ID
None.
Query parameters
You can get a list of information about pairs in a snapshot group, as well as detailed information about a pair in a snapshot group.
Parameter
Type
Description
snapshotGroupName
string
(Optional) Specify the name of the snapshot group that contains the Thin Image pairs.
Specify a character string consisting of 1 to 32 characters.
Specify this parameter to get a list of information about pairs in the target snapshot group.
If this parameter is omitted, this request gets a list of snapshot groups.
You cannot specify both this parameter and the
detailInfoType
parameter.detailInfoType
string
(Optional) Type of detailed information to be obtained
- pair
Gets detailed information about the pairs in each snapshot group in addition to a list of snapshot groups.
You can specify this item for VSP 5000 series.
To get up-to-date information, you must run the API request that refreshes the storage system's cache before running this request. For details, see "Updating the cache of storage system configuration information".
You cannot specify both this parameter and the
snapshotGroupName
parameter.- pair
Body
None.
Body
The following is an example of the output generated when getting a list of snapshot groups:
{ "data": [ { "snapshotGroupName": "snapshotGroup", "snapshotGroupId": "snapshotGroup" }, { "snapshotGroupName": "snapshotGroup2", "snapshotGroupId": "snapshotGroup2" } ] }
Attribute
Type
Description
snapshotGroupName
string
Name of the snapshot group that contains the Thin Image pairs.
If the name of the snapshot group contains spaces, information about that snapshot group is not output.
snapshotGroupId
string
Object ID of the snapshot group.
The following is an example of the output when the request for getting a list of information about pairs in a snapshot group is executed with
snapshotGroupName
specified as the query parameter. If multiple pairs exist, the information is output in ascending order of the LDEV number and MU number of the primary volume.{ "data": [ { "snapshotGroupName": "snapshotGroup", "primaryOrSecondary": "P-VOL", "status": "PSUS", "pvolLdevId": 100, "muNumber": 3, "svolLdevId": 101, "snapshotPoolId": 10, "concordanceRate": 100, "isConsistencyGroup": true, "isWrittenInSvol": false, "isClone": false, "canCascade": false, "splitTime": "2015-03-20T09:27:35", "snapshotId": "100,3", "pvolProcessingStatus": "N", "snapshotDataReadOnly": false }, { "snapshotGroupName": "snapshotGroup", "primaryOrSecondary": "P-VOL", "status": "PSUS", "pvolLdevId": 100, "muNumber": 4, "snapshotPoolId": 10, "concordanceRate": 100, "isConsistencyGroup": true, "isWrittenInSvol": false, "isClone": false, "canCascade": false, "splitTime": "2015-03-20T09:27:35", "snapshotId": "100,4", "pvolProcessingStatus": "N", "snapshotDataReadOnly": false } ] }
Attribute
Type
Description
snapshotGroupName
string
Name of the snapshot group that contains the Thin Image pairs.
If the name of the snapshot group contains spaces, information about pairs is not output.
primaryOrSecondary
string
Attribute of the LDEV
status
string
Pair status
For details, see the section explaining on pair status (Thin Image).
pvolLdevId
int
LDEV number of P-VOL
muNumber
int
MU number of the P-VOL
svolLdevId
int
LDEV number of S-VOL
snapshotPoolId
int
ID of the pool in which the snapshot data is created
concordanceRate
int
Concordance rate for pairs
This attribute is output when any of the following conditions are met:
- The value of the
isClone
attribute is false, and the value of thecanCascade
attribute is also false. - The value of the
isClone
attribute is true, and the value of thestatus
attribute is not COPY, RCPY, SMPP, or PSUP. - The value of the
canCascade
attribute is true, and the value ofstatus
attribute is not COPY, RCPY, SMPP, or PSUP.
progressRate
int
Progress of the processing
This attribute is output when either of the following conditions is met:
- The value of the
isClone
attribute is true, and the value of thestatus
attribute is COPY, RCPY, SMPP, or PSUP. - The value of the
canCascade
attribute is true, and the value of thestatus
attribute is COPY, RCPY, SMPP, or PSUP.
isConsistencyGroup
boolean
Returns whether the pair was created in the consistency group mode (CTG mode).
- true: The pair was created in the CTG mode.
- false: The pair was not created in the CTG mode.
isWrittenInSvol
boolean
Returns whether data was written to the S-VOL from the host when the pair status was PSUS/PFUS.
- true: Data was written to the S-VOL
- false: Data was not written to the S-VOL
If the target pair is a Thin Image pair that does not have an S-VOL, false is displayed.
isClone
boolean
Returns whether the pair has the clone attribute.
- true: The pair has the clone attribute.
- false: The pair does not have the clone attribute.
canCascade
boolean
Returns whether the pair can be a cascaded pair.
- true: The pair can be a cascaded pair.
- false: The pair cannot be a cascaded pair.
splitTime
string
Time when snapshot data was created
The local time of the storage system is returned in YYYY-MM-DDThh:mm:ss format.
snapshotId
string
Object ID of the Thin Image pair
The following attributes are output, separated by commas:
- pvolLdevId
- muNumber
pvolProcessingStatus
string
Processing status of the pair
- E: The expansion processing is in progress.
- N: The expansion processing is not in progress.
This attribute is output when the value of the
primaryOrSecondary
attribute is P-VOL.svolProcessingStatus
string
Processing status of the pair
- E: The expansion processing is in progress.
- N: The expansion processing is not in progress.
This attribute is output when the value of the
primaryOrSecondary
attribute is S-VOL.snapshotDataReadOnly
boolean
Returns whether the snapshot data is a pair that has the read-only attribute
- true: Read-only
- false: Not read-only
If you run the request with pair specified for the query parameter
detailInfoType
, you can get the following information, in addition to a list of snapshot groups. If multiple pairs exist, the information is output in ascending order of the LDEV number and MU number of the primary volume.Attribute
Type
Description
snapshots
object[]
Outputs the following attributes related to Thin Image pairs contained in the snapshot group.
- snapshotGroupName (string)
Name of the snapshot group
- status (string)
Pair status
For details, see the section explaining on pair status (Thin Image).
- pvolLdevId (int)
LDEV number of P-VOL
- muNumber (int)
MU number of the P-VOL
- svolLdevId (int)
LDEV number of S-VOL
This attribute is displayed if the target pair is a Thin Image pair that has an S-VOL.
- snapshotPoolId (int)
ID of the pool in which the snapshot data is created
- concordanceRate (int)
Concordance rate for pairs
This attribute is displayed if the pair status is not SMPL.
- isConsistencyGroup (boolean)
Returns whether the pair was created in the consistency group mode (CTG mode).
- true: The pair was created in the CTG mode.
- false: The pair was not created in the CTG mode.
- isWrittenInSvol (boolean)
Returns whether data was written to the S-VOL from the host when the pair status was PSUS/PFUS.
- true: Data was written to the S-VOL
- false: Data was not written to the S-VOL
If the target pair is a Thin Image pair that does not have an S-VOL, false is displayed.
- isClone (boolean)
Returns whether the pair has the clone attribute.
- true: The pair has the clone attribute.
- false: The pair does not have the clone attribute.
- canCascade (boolean)
Returns whether the pair can be a cascaded pair.
- true: The pair can be a cascaded pair.
- false: The pair cannot be a cascaded pair.
- splitTime (string)
Time when snapshot data was created
This attribute is displayed if the pair status is PSUS, PFUS, or PSUP.
The storage system time in Greenwich Mean Time (GMT) is displayed in the YYYY-MM-DDThh:mm:ss format.
- snapshotId (string)
Object ID of the Thin Image pair
The following attributes are output, separated by commas:
pvolLdevId
muNumber
- The value of the
For details on the status codes of the request for this operation, see the description on HTTP status codes.
curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/snapshot-groups
Getting information about Thin Image pairs in a specified snapshot group
Storage Administrator (View Only)
GET base-URL/v1/objects/snapshot-groups/object-ID
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.
Specify a character string consisting of 1 to 32 characters. The name is case sensitive.
Query parameters
None.
Body
None.
Body
{ "snapshotGroupName" : "snapshotGroup", "snapshotGroupId" : "snapshotGroup", "snapshots" : [ { "snapshotGroupName": "snapshotGroup", "primaryOrSecondary": "P-VOL", "status": "PSUS", "pvolLdevId": 100, "muNumber": 3, "svolLdevId": 101, "snapshotPoolId": 10, "concordanceRate": 100, "isConsistencyGroup": true, "isWrittenInSvol": false, "isClone": false, "canCascade": false, "splitTime": "2015-03-20T09:27:35", "snapshotId": "100,3", "pvolProcessingStatus": "N", "snapshotDataReadOnly": false }, { "snapshotGroupName": "snapshotGroup", "primaryOrSecondary": "P-VOL", "status": "PSUS", "pvolLdevId": 100, "muNumber": 4, "snapshotPoolId": 10, "concordanceRate": 100, "isConsistencyGroup": true, "isWrittenInSvol": false, "isClone": false, "canCascade": false, "splitTime": "2015-03-20T09:27:35", "snapshotId": "100,4", "pvolProcessingStatus": "N", "snapshotDataReadOnly": false } ] }
Attribute
Type
Description
snapshotGroupName
string
Name of the snapshot group that contains the Thin Image pairs.
If the name of the snapshot group contains spaces, information about pairs is not output.
snapshotGroupId
string
Object ID of the snapshot group
snapshots
object[]
Outputs the following attributes related to Thin Image pairs contained in the snapshot group.
- snapshotGroupName (string)
Name of the snapshot group
- primaryOrSecondary (string)
Attribute of the LDEV
- status (string)
Pair status
For details, see the section explaining on pair status (Thin Image).
- pvolLdevId (int)
LDEV number of P-VOL
- muNumber (int)
MU number of the P-VOL
- svolLdevId (int)
LDEV number of S-VOL
- snapshotPoolId (int)
ID of the pool in which the snapshot data is created
- concordanceRate (int)
Concordance rate for pairs
This attribute is output when any of the following conditions are met:
- The value of the
isClone
attribute is false, and the value of thecanCascade
attribute is also false. - The value of the
isClone
attribute is true, and the value of thestatus
attribute is not COPY, RCPY, SMPP, or PSUP. - The value of the
canCascade
attribute is true, and the value ofstatus
attribute is not COPY, RCPY, SMPP, or PSUP.
- The value of the
- progressRate (int)
Progress of the processing
This attribute is output when either of the following conditions is met:
- The value of the
isClone
attribute is true, and the value of thestatus
attribute is COPY, RCPY, SMPP, or PSUP. - The value of the
canCascade
attribute is true, and the value of thestatus
attribute is COPY, RCPY, SMPP, or PSUP.
- The value of the
- isConsistencyGroup (boolean)
Returns whether the pair was created in the consistency group mode (CTG mode).
- true: The pair was created in the CTG mode.
- false: The pair was not created in the CTG mode.
- isWrittenInSvol (boolean)
Returns whether data was written to the S-VOL from the host when the pair status was PSUS/PFUS.
- true: Data was written to the S-VOL
- false: Data was not written to the S-VOL
If the target pair is a Thin Image pair that does not have an S-VOL, false is displayed.
- isClone (boolean)
Returns whether the pair has the clone attribute.
- true: The pair has the clone attribute.
- false: The pair does not have the clone attribute.
- canCascade (boolean)
Returns whether the pair can be a cascaded pair.
- true: The pair can be a cascaded pair.
- false: The pair cannot be a cascaded pair.
- splitTime (string)
Time when snapshot data was created
The local time of the storage system is returned in YYYY-MM-DDThh:mm:ss format.
- snapshotId (string)
Object ID of the Thin Image pair
The following attributes are output, separated by commas:
pvolLdevId
muNumber
-
pvolProcessingStatus (string)
Processing status of the pair
- E: The expansion processing is in progress.
- N: The expansion processing is not in progress.
This attribute is output when the value of the
primaryOrSecondary
attribute is P-VOL. -
svolProcessingStatus (string)
Processing status of the pair
- E: The expansion processing is in progress.
- N: The expansion processing is not in progress.
This attribute is output when the value of the
primaryOrSecondary
attribute is S-VOL. -
snapshotDataReadOnly (boolean)
Returns whether the snapshot data is a pair that has the read-only attribute
- true: Read-only
- false: Not read-only
- snapshotGroupName (string)
For details on the status codes of the request for this operation, see the description on HTTP status codes.
curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/snapshot-groups/snapshotGroup
Getting information about Thin Image pairs
Storage Administrator (View Only)
GET base-URL/v1/objects/snapshots
Object ID
None.
Query parameters
Parameter
Type
Filter Condition
snapshotGroupName
string
(Optional) Specify the name of the snapshot group that contains the Thin Image pairs.
Specify a character string consisting of 1 to 32 characters.
pvolLdevId
int
(Optional) Specify the LDEV number of the P-VOL of the Thin Image pair.
Specify a decimal (base 10) number equal to or greater than 0.
svolLdevId
int
(Optional) Specify the LDEV number of the S-VOL of the Thin Image pair.
If the S-VOL exists, specify a decimal (base 10) number equal to or greater than 0.
muNumber
int
(Optional) Specify the MU number of the P-VOL of the Thin Image pair.
Specify a value in the range from 0 to 1023.
The following shows how to specify parameters:
- The LDEV number of the P-VOL and the snapshot group name
- The LDEV number and the MU number of the P-VOL
- Only the LDEV number of the P-VOL
- If the secondary volume exists, only the LDEV number of the S-VOL
If no parameters are specified, an error occurs.
Body
None.
Body
If information about multiple Thin Image pairs is obtained, the information is output in ascending order of the LDEV number and MU number of the primary volume.
The following is an output example of Thin Image pair information obtained by specifying the LDEV number of the primary volume and the snapshot group name:
{ "data": [ { "snapshotGroupName": "snapshotGroup", "primaryOrSecondary": "P-VOL", "status": "PSUS", "pvolLdevId": 100, "muNumber": 3, "svolLdevId": 101, "snapshotPoolId": 10, "concordanceRate": 100, "isConsistencyGroup": true, "isWrittenInSvol": false, "isClone": false, "canCascade": false, "splitTime": "2015-03-20T09:27:35", "snapshotId": "100,3", "pvolProcessingStatus": "N", "snapshotDataReadOnly": false }, { "snapshotGroupName": "snapshotGroup", "primaryOrSecondary": "P-VOL", "status": "PSUS", "pvolLdevId": 100, "muNumber": 4, "snapshotPoolId": 10, "concordanceRate": 100, "isConsistencyGroup": true, "isWrittenInSvol": false, "isClone": false, "canCascade": false, "splitTime": "2015-03-20T09:27:35", "snapshotId": "100,4", "pvolProcessingStatus": "N", "snapshotDataReadOnly": false } ] }
The following is an output example of Thin Image pair information obtained by specifying the LDEV number and the MU number of the primary volume:
{ "data": [ { "snapshotGroupName": "snapshotGroup", "primaryOrSecondary": "P-VOL", "status": "PSUS", "pvolLdevId": 100, "muNumber": 3, "svolLdevId": 101, "snapshotPoolId": 10, "concordanceRate": 100, "isConsistencyGroup": true, "isWrittenInSvol": false, "isClone": false, "canCascade": false, "splitTime": "2015-03-20T09:27:35", "snapshotId": "100,3", "pvolProcessingStatus": "N", "snapshotDataReadOnly": false } ] }
The following is an output example of Thin Image pair information obtained by specifying the LDEV number of the primary volume:
{ "data": [ { "snapshotGroupName": "snapshotGroup", "primaryOrSecondary": "P-VOL", "status": "PSUS", "pvolLdevId": 100, "muNumber": 3, "svolLdevId": 101, "snapshotPoolId": 10, "concordanceRate": 100, "isConsistencyGroup": true, "isWrittenInSvol": false, "isClone": false, "canCascade": false, "splitTime": "2015-03-20T09:27:35", "snapshotId": "100,3", "pvolProcessingStatus": "N", "snapshotDataReadOnly": false }, { "snapshotGroupName": "snapshotGroup", "primaryOrSecondary": "P-VOL", "status": "PSUS", "pvolLdevId": 100, "muNumber": 4, "snapshotPoolId": 10, "concordanceRate": 100, "isConsistencyGroup": true, "isWrittenInSvol": false, "isClone": false, "canCascade": false, "splitTime": "2015-03-20T09:27:35", "snapshotId": "100,4", "pvolProcessingStatus": "N", "snapshotDataReadOnly": false } ] }
The following is an output example of Thin Image pair information obtained by specifying the LDEV number of the secondary volume:
{ "data": [ { "snapshotGroupName": "snapshotGroup", "primaryOrSecondary": "P-VOL", "status": "PSUS", "pvolLdevId": 100, "muNumber": 3, "svolLdevId": 101, "snapshotPoolId": 10, "concordanceRate": 100, "isConsistencyGroup": true, "isWrittenInSvol": false, "isClone": false, "canCascade": false, "splitTime": "2015-03-20T09:27:35", "snapshotId": "100,3", "pvolProcessingStatus": "N", "snapshotDataReadOnly": false } ] }
Attribute
Type
Description
snapshotGroupName
string
Name of the snapshot group that contains the Thin Image pairs.
If the name of the snapshot group contains spaces, information about pairs is not output.
primaryOrSecondary
string
Attribute of the LDEV
status
string
Pair status
For details, see the section explaining on pair status (Thin Image).
pvolLdevId
int
LDEV number of P-VOL
muNumber
int
MU number of the P-VOL
svolLdevId
int
LDEV number of S-VOL
snapshotPoolId
int
ID of the pool in which the snapshot data is created
concordanceRate
int
Concordance rate for pairs
This attribute is output when any of the following conditions are met:
- The value of the
isClone
attribute is false, and the value of thecanCascade
attribute is also false. - The value of the
isClone
attribute is true, and the value of thestatus
attribute is not COPY, RCPY, SMPP, or PSUP. - The value of the
canCascade
attribute is true, and the value ofstatus
attribute is not COPY, RCPY, SMPP, or PSUP.
progressRate
int
Progress of the processing
This attribute is output when either of the following conditions is met:
- The value of the
isClone
attribute is true, and the value of thestatus
attribute is COPY, RCPY, SMPP, or PSUP. - The value of the
canCascade
attribute is true, and the value of thestatus
attribute is COPY, RCPY, SMPP, or PSUP.
isConsistencyGroup
boolean
Returns whether the pair was created in the consistency group mode (CTG mode).
- true: The pair was created in the CTG mode.
- false: The pair was not created in the CTG mode.
isWrittenInSvol
boolean
Returns whether data was written to the S-VOL from the host when the pair status was PSUS/PFUS.
- true: Data was written to the S-VOL
- false: Data was not written to the S-VOL
If the target pair is a Thin Image pair that does not have an S-VOL, false is displayed.
isClone
boolean
Returns whether the pair has the clone attribute.
- true: The pair has the clone attribute.
- false: The pair does not have the clone attribute.
canCascade
boolean
Returns whether the pair can be a cascaded pair.
- true: The pair can be a cascaded pair.
- false: The pair cannot be a cascaded pair.
splitTime
string
Time when snapshot data was created
The local time of the storage system is returned in YYYY-MM-DDThh:mm:ss format.
snapshotId
string
Object ID of the Thin Image pair
The following attributes are output, separated by commas:
- pvolLdevId
- muNumber
pvolProcessingStatus
string
Processing status of the pair
- E: The expansion processing is in progress.
- N: The expansion processing is not in progress.
This attribute is output when the value of the
primaryOrSecondary
attribute is P-VOL.svolProcessingStatus
string
Processing status of the pair
- E: The expansion processing is in progress.
- N: The expansion processing is not in progress.
This attribute is output when the value of the
primaryOrSecondary
attribute is S-VOL.snapshotDataReadOnly
boolean
Returns whether the snapshot data is a pair that has the read-only attribute
- true: Read-only
- false: Not read-only
- The value of the
For details on the status codes of the request for this operation, see the description on HTTP status codes.
When the LDEV number of the P-VOL and the snapshot group name are specified:
curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET "https://192.0.2.100/ConfigurationManager/v1/objects/snapshots?pvolLdevId=100&snapshotGroupName=snapshotGroup"
When the LDEV number and the MU number of the P-VOL are specified:
curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET "https://192.0.2.100/ConfigurationManager/v1/objects/snapshots?pvolLdevId=100&muNumber=3"
When only the LDEV number of the P-VOL is specified:
curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/snapshots?pvolLdevId=100
If the secondary volume exists, when only the LDEV number of the S-VOL is specified:
curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/snapshots?svolLdevId=101
Getting information about a specific Thin Image pair
Storage Administrator (View Only)
GET base-URL/v1/objects/snapshots/object-ID
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) Specify the LDEV number of the P-VOL of the Thin Image pair.
Specify a decimal (base 10) number equal to or greater than 0.
muNumber
int
(Required) Specify the MU number of the P-VOL of the Thin Image pair.
Specify a value in the range from 0 to 1023.
Query parameters
None.
Body
None.
Body
{ "snapshotGroupName": "snapshotGroup", "primaryOrSecondary": "P-VOL", "status": "PSUS", "pvolLdevId": 100, "muNumber": 3, "svolLdevId": 101, "snapshotPoolId": 10, "concordanceRate": 100, "isConsistencyGroup": true, "isWrittenInSvol": false, "isClone": false, "canCascade": false, "splitTime": "2015-03-20T09:27:35", "snapshotId": "100,3", "pvolProcessingStatus": "N", "snapshotDataReadOnly": false }
Attribute
Type
Description
snapshotGroupName
string
Name of the snapshot group that contains the Thin Image pairs.
If the name of the snapshot group contains spaces, information about pairs is not output.
primaryOrSecondary
string
Attribute of the LDEV
status
string
Pair status
For details, see the section explaining on pair status (Thin Image).
pvolLdevId
int
LDEV number of P-VOL
muNumber
int
MU number of the P-VOL
svolLdevId
int
LDEV number of S-VOL
snapshotPoolId
int
ID of the pool in which the snapshot data is created
concordanceRate
int
Concordance rate for pairs
This attribute is output when any of the following conditions are met:
- The value of the
isClone
attribute is false, and the value of thecanCascade
attribute is also false. - The value of the
isClone
attribute is true, and the value of thestatus
attribute is not COPY, RCPY, SMPP, or PSUP. - The value of the
canCascade
attribute is true, and the value ofstatus
attribute is not COPY, RCPY, SMPP, or PSUP.
progressRate
int
Progress of the processing
This attribute is output when either of the following conditions is met:
- The value of the
isClone
attribute is true, and the value of thestatus
attribute is COPY, RCPY, SMPP, or PSUP. - The value of the
canCascade
attribute is true, and the value of thestatus
attribute is COPY, RCPY, SMPP, or PSUP.
isConsistencyGroup
boolean
Returns whether the pair was created in the consistency group mode (CTG mode).
- true: The pair was created in the CTG mode.
- false: The pair was not created in the CTG mode.
isWrittenInSvol
boolean
Returns whether data was written to the S-VOL from the host when the pair status was PSUS/PFUS.
- true: Data was written to the S-VOL
- false: Data was not written to the S-VOL
If the target pair is a Thin Image pair that does not have an S-VOL, false is displayed.
isClone
boolean
Returns whether the pair has the clone attribute.
- true: The pair has the clone attribute.
- false: The pair does not have the clone attribute.
canCascade
boolean
Returns whether the pair can be a cascaded pair.
- true: The pair can be a cascaded pair.
- false: The pair cannot be a cascaded pair.
splitTime
string
Time when snapshot data was created
The local time of the storage system is returned in YYYY-MM-DDThh:mm:ss format.
snapshotId
string
Object ID of the Thin Image pair
The following attributes are output, separated by commas:
- pvolLdevId
- muNumber
pvolProcessingStatus
string
Processing status of the pair
- E: The expansion processing is in progress.
- N: The expansion processing is not in progress.
This attribute is output when the value of the
primaryOrSecondary
attribute is P-VOL.svolProcessingStatus
string
Processing status of the pair
- E: The expansion processing is in progress.
- N: The expansion processing is not in progress.
This attribute is output when the value of the
primaryOrSecondary
attribute is S-VOL.snapshotDataReadOnly
boolean
Returns whether the snapshot data is a pair that has the read-only attribute
- true: Read-only
- false: Not read-only
- The value of the
For details on the status codes of the request for this operation, see the description on HTTP status codes.
curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/snapshots/100,3
Getting information about all of Thin Image pairs
-
This API can be used when the storage system is the VSP 5000 series.
-
To get up-to-date information, you must run the API request that refreshes the storage system's cache before running this request. For details, see "Updating the cache of storage system configuration information".
Storage Administrator (View Only)
GET base-URL/v1/objects/snapshot-replications
Object ID
None.
Query parameters
Parameter
Type
Description
startPvolLdevId
int
(Optional) To specify a range of LDEVs, specify the LDEV number of the first LDEV in the range.
The P-VOLs in the specified range of LDEVs are searched, and information about the relevant pairs is obtained.
Specify a value in the range from 0 to 65279.
The value of this parameter must be smaller than that of the
endPvolLdevId
parameter.If this attribute is omitted, 0 is set.
endPvolLdevId
int
(Optional) To specify a range of LDEVs, specify the LDEV number of the last LDEV in the range.
The P-VOLs in the specified range of LDEVs are searched, and information about the relevant pairs is obtained.
Specify a value in the range from 0 to 65279.
The value of this parameter must be greater than that of the
startPvolLdevId
parameter.If this attribute is omitted, the maximum LDEV number in the storage system is set.
Body
None.
Body
{ "data": [ { "snapshotReplicationId": "20900,3", "pvolLdevId": 20900, "svolLdevId": 20904, "snapshotPoolId": 103, "status": "PAIR", "concordanceRate": 100, "muNumber": 3, "isClone": false, "canCascade": false }, { "snapshotReplicationId": "20912,3", "pvolLdevId": 20912, "svolLdevId": 20905, "snapshotPoolId": 104, "status": "PAIR", "concordanceRate": 90, "muNumber": 3, "isClone": false, "canCascade": false }, { "snapshotReplicationId": "20912,4", "pvolLdevId": 20912, "svolLdevId": 20906, "snapshotPoolId": 104, "status": "PAIR", "concordanceRate": 80, "muNumber": 4, "isClone": false, "canCascade": false } ] }
Attribute
Type
Description
snapshotReplicationId
string
Object ID of the Thin Image pair
The following attributes are output, separated by commas:
pvolLdevId
muNumber
snapshotGroupName
string
Name of the snapshot group
This attribute is output if the target pair belongs to a snapshot group.
pvolLdevId
int
LDEV number of P-VOL
snapshotPoolId
int
ID of the pool in which the snapshot data was created
svolLdevId
int
LDEV number of S-VOL
This attribute is displayed if the target pair is a Thin Image pair that has an S-VOL.
status
string
Pair status
SMPP
COPY
PAIR
PSUS
PFUL
PSUE
PFUS
RCPY
PSUP
OTHER
consistencyGroupId
int
Consistency group ID
If no consistency group consists, information is not output.
concordanceRate
int
Concordance rate for pairs
muNumber
int
MU number of the P-VOL
splitTime
string
Time when snapshot data was created
The local time of the storage system is returned in YYYY-MM-DDThh:mm:ss format.
This attribute is output if the pair status is
PSUS
orPSUP
.isClone
boolean
Returns whether the pair has the clone attribute.
- true: The pair has the clone attribute.
- false: The pair does not have the clone attribute.
canCascade
boolean
Returns whether the pair can be a cascaded pair.
- true: The pair that is or can be used in a cascade configuration.
- false: The pair cannot be a cascaded pair.
For details on the status codes for the request that performs this operation, see the description of HTTP status codes.
curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/snapshot-replications
Creating a Thin Image pair
Storage Administrator (Local Copy)
POST base-URL/v1/objects/snapshots
Object ID
None.
Query parameters
None.
Body
The following is an example of coding used for creating a Thin Image pair.
If the secondary volume does not exist :
{ "snapshotGroupName": "snapshotGroup", "snapshotPoolId": 13, "pvolLdevId": 100, "isConsistencyGroup": true, "autoSplit": true, "isDataReductionForceCopy": true }
If the secondary volume exists:
{ "snapshotGroupName": "snapshotGroup", "snapshotPoolId": 13, "pvolLdevId": 100, "svolLdevId": 101, "isConsistencyGroup": true, "autoSplit": true, "isDataReductionForceCopy": true }
Attribute
Type
Description
snapshotGroupName
string
(Required) Specify the name of the snapshot group for which the Thin Image pair is to be created.
Specify a character string consisting of 1 to 32 characters. The name is case sensitive. If you specify a new group name, a snapshot group is also created at the same time.
snapshotPoolId
int
(Required) Specify the ID of the pool in which snapshot data is to be created.
Specify the ID of a Thin Image pool or an HDP pool by using a decimal (base 10) number equal to or greater than 0.
pvolLdevId
int
(Required) Specify the LDEV number of the P-VOL of the Thin Image pair to be created.
Specify a decimal (base 10) number equal to or greater than 0.
svolLdevId
int
(Optional) Specify the LDEV number of the S-VOL of the Thin Image pair to be created.
This item is required when true is specified for the
isClone
attribute.If you specified true for the
isClone
attribute or thecanCascade
attribute, specify the LDEV number of the DP volume.Specify a decimal (base 10) number equal to or greater than 0.
If you do not specify this item, a Thin Image pair that does not have the S-VOL will be created.
isConsistencyGroup
boolean
(Optional) Regarding the snapshot group for which the Thin Image pair is to be created, specify whether the snapshot group is to be created in the consistency group mode (CTG mode).
- true: Creates the snapshot group in the CTG mode.
- false: Does not create the snapshot group in the CTG mode.
If you do not specify this item, false will be set.
autoSplit
boolean
(Optional) Specify whether the Thin Image pair is to be split after it is created.
- 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 specify true for this attribute, you cannot specify true for the
isClone
attribute.If you do not specify this item, false will be set.
canCascade boolean (Optional) Specify whether the pair can be cascaded.
- true: The pair can be cascaded.
- false: The pair cannot be cascaded.
If you specify true for the
isClone
attribute, also specify true for this attribute.If you do not specify this item, the same value as for the
isClone
attribute will be set.isClone boolean (Optional) Specify whether to create a pair that has the clone attribute specified.
- true: Creates a pair that has the clone attribute specified.
- false: Creates a pair that does not have the clone attribute specified.
If you specify true for this attribute, do not specify the
autoSplit
attribute.If you specify true for this attribute, specify true for the
canCascade
attribute.If you do not specify this item, false will be set.
clonesAutomation boolean (Optional) Specify whether the pair is to be cloned after the pair is created.
You can specify this item when true is specified for the
isClone
attribute.- true: Clones the pair.
- false: Does not clone the pair.
If you do not specify this item, false will be set.
copySpeed string (Optional) Specify the copy speed at which the created pair is to be cloned.
You can specify this item when true is specified for both the
isClone
attribute and theclonesAutomation
attribute.- slower: Low speed
- medium: Medium speed
- faster: High speed
This item is not case sensitive.
If you do not specify this item, medium will be set.
isDataReductionForceCopy
boolean
(Optional) Specify whether to forcibly create a pair for a volume for which the capacity saving function (dedupe and compression) is enabled.
When creating a pair for a volume for which the capacity saving function is enabled, always specify true.
- true: Forcibly create a pair for data reduplication volumes.#
- false: Do not forcibly create a pair for data reduplication volumes.
If you do not specify this item, false will be set.
muNumber
int
(Optional) Specify the MU number of the P-VOL of the Thin Image pair to be created.
Specify a value in the range from 0 to 1023. You cannot specify a MU number that is already in use.
If you do not specify this item, an available MU number will be assigned.
#: If you create a pair by using volumes for which the capacity saving function (compression or deduplication) is enabled, data that has been compressed or deduplicated will be copied and, as a result, the performance of the copying processing or the I/O performance of the host might decrease. In addition, if false is specified for the
autoSplit
attribute, use the status of the target resource rather than the status of the job to check whether the pair has been created.
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 created Thin Image pair
For details on the status codes of the request for this operation, see the description on HTTP status codes.
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
Storing snapshot data in units of snapshot groups
Storage Administrator (Local Copy)
POST base-URL/v1/objects/snapshot-groups/object-ID/actions/split/invoke
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 split belong.
Specify a character string consisting of 1 to 32 characters. The name is case sensitive.
Query parameters
None.
Body
None.
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 split snapshot group
GET base-URL/v1/objects/snapshot-groups/object-ID/actions/split
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 when pairs are split in units of snapshot groups. |
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/split
To run the request after getting an action template:
curl -v -H "Content-type: application/json" -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST https://192.0.2.100/ConfigurationManager/v1/objects/snapshot-groups/snapshotGroup/actions/split/invoke -d ""
Storing snapshot data
Storage Administrator (Local Copy)
POST base-URL/v1/objects/snapshots/object-ID/actions/split/invoke
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) Specify the LDEV number of the P-VOL of the Thin Image pair to be split.
Specify a decimal (base 10) number equal to or greater than 0.
muNumber
int
(Required) Specify the MU number of the P-VOL of the Thin Image pair to be split.
Specify a value in the range from 0 to 1023.
Query parameters
None.
Body
None.
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 split Thin Image pair
GET base-URL/v1/objects/snapshots/object-ID/actions/split
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 when pairs are split. |
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/split
To run the request after getting an action template:
curl -v -H "Content-type: application/json" -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST https://192.0.2.100/ConfigurationManager/v1/objects/snapshots/100,3/actions/split/invoke -d ""
Resynchronizing Thin Image pair in units of snapshot groups and deleting snapshot data
Storage Administrator (Local Copy)
POST base-URL/v1/objects/snapshot-groups/object-ID/actions/resync/invoke
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 resynchronized 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 resynchronization 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.
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 resynchronized snapshot group
GET base-URL/v1/objects/snapshot-groups/object-ID/actions/resync
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 the resynchronization of pairs in units of snapshot groups. |
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/resync
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/resync/invoke
Resynchronizing a Thin Image pair and deleting snapshot data
Storage Administrator (Local Copy)
POST base-URL/v1/objects/snapshots/object-ID/actions/resync/invoke
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 resynchronized.
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 resynchronized.
Specify a value in the range from 0 to 1023.
Query parameters
None.
Body
{ "parameters": { "autoSplit": false } }
Attribute
Type
Description
autoSplit
boolean
(Optional) After resynchronization 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.
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 resynchronized Thin Image pairs
GET base-URL/v1/objects/snapshots/object-ID/actions/resync
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 pair resynchronization. |
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/resync
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/resync/invoke
Restoring snapshot data in units of snapshot groups
Storage Administrator (Local Copy)
POST base-URL/v1/objects/snapshot-groups/object-ID/actions/restore/invoke
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.
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
GET base-URL/v1/objects/snapshot-groups/object-ID/actions/restore
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. |
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
Restoring snapshot data
Storage Administrator (Local Copy)
POST base-URL/v1/objects/snapshots/object-ID/actions/restore/invoke
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.
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
GET base-URL/v1/objects/snapshots/object-ID/actions/restore
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. |
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
Assigning a secondary volume to snapshot data
Storage Administrator (Local Copy)
POST base-URL/v1/objects/snapshots/object-ID/actions/assign-volume/invoke
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 a Thin Image pair that has snapshot data
Specify a decimal (base 10) number equal to or greater than 0.
muNumber
int
(Required) MU number of the P-VOL of a Thin Image pair that has snapshot data
Specify a value in the range from 0 to 1023.
Query parameters
None.
Body
{ "parameters": { "svolLdevId": 101 } }
Attribute
Type
Description
svolLdevId
int
(Required) LDEV number of the S-VOL to be assigned to the snapshot data
Specify a decimal (base 10) number equal to or greater than 0. For the S-VOL, specify a virtual volume for Thin Image that was created beforehand.
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 Thin Image pair whose S-VOL was assigned
GET base-URL/v1/objects/snapshots/object-ID/actions/assign-volume
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 S-VOL assignment. |
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/assign-volume
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/assign-volume/invoke
Unassigning the secondary volume for snapshot data
Storage Administrator (Local Copy)
POST base-URL/v1/objects/snapshots/object-ID/actions/unassign-volume/invoke
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 a Thin Image pair that has snapshot data
Specify a decimal (base 10) number equal to or greater than 0.
muNumber
int
(Required) MU number of the P-VOL of a Thin Image pair that has snapshot data
Specify a value in the range from 0 to 1023.
Query parameters
None.
Body
None.
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 Thin Image pair whose S-VOL was unassigned
GET base-URL/v1/objects/snapshots/object-ID/actions/unassign-volume
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 when an S-VOL is unassigned. |
To get an action template:
You can check whether the secondary volume of a Thin Image pair that has a specified object ID can be unassigned.
curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/snapshots/100,3/actions/unassign-volume
To run the request after getting an action template:
curl -v -H "Content-type: application/json" -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST https://192.0.2.100/ConfigurationManager/v1/objects/snapshots/100,3/actions/unassign-volume/invoke -d ""
Deleting Thin Image pairs in units of snapshot groups
Storage Administrator (Local Copy)
DELETE base-URL/v1/objects/snapshot-groups/object-ID
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 deleted belong.
Specify a character string consisting of 1 to 32 characters. The name is case sensitive.
Query parameters
None.
Body
None.
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 deleted snapshot group
For details on the status codes of the request for this operation, see the description on HTTP status codes.
curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X DELETE https://192.0.2.100/ConfigurationManager/v1/objects/snapshot-groups/snapshotGroup
Deleting a Thin Image pair
Storage Administrator (Local Copy)
DELETE base-URL/v1/objects/snapshots/object-ID
Object ID
Specify the
snapshotId
value obtained by getting information about a Thin Image pair. You can also specify the following attributes and connect them with commas:pvolLdevId,muNumber
Attribute
Type
Description
pvolLdevId
int
(Required) Specify the LDEV number of the P-VOL of the Thin Image pair to be deleted.
Specify a decimal (base 10) number equal to or greater than 0.
muNumber
int
(Required) Specify the MU number of the P-VOL of the Thin Image pair to be deleted.
Specify a value in the range from 0 to 1023.
Query parameters
None.
Body
None.
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 deleted Thin Image pair
For details on the status codes of the request for this operation, see the description on HTTP status codes.
curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X DELETE https://192.0.2.100/ConfigurationManager/v1/objects/snapshots/100,3
Deleting Thin Image pairs by snapshot tree
If you use a configuration in which multiple snapshot trees are connected through pairs whose clone attribute is enabled, specify the root volume of the top snapshot tree first and run the API request. This action does not delete pairs in the snapshot trees under the secondary volumes of pairs whose clone attribute is enabled, but changes the statuses of pairs in those snapshot trees to PSUE.
Then, specify the root volume of the snapshot tree under the secondary volume, and run the API request.
Storage Administrator (Local Copy)
POST base-URL/v1/services/snapshot-tree/actions/delete/invoke
Object ID
None.
Query parameters
None.
Body
{ "parameters": { "ldevId": 1 } }
Attribute
Type
Description
ldevId
int
(Required) LDEV number of the root volume
Body
A job object is returned. For details on attributes other than
affectedResources
, see the section that explains job objects.Attribute
Description
affectedResources
URL of the root volume
By referring to the
attributes
attribute value, confirm that this is no longer a Thin Image volume.To verify that all pairs within the snapshot tree have been deleted, obtain the pair statuses and volume attributes based on the pair information you confirmed in advance.
None.
For details about the status codes issued in response to requests for this operation, see the description of HTTP status codes.
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/services/snapshot-tree/actions/delete/invoke
Deleting garbage data of all Thin Image pairs in a snapshot tree
You can delete garbage data (defragment the snapshot data area) by specifying the root volume of a snapshot tree. You can stop the processing before the deletion processing is complete. Before running this API request, we recommend that you get volume information to check the usage status of snapshots and the volume of garbage data.
You can use this API request for VSP 5000 series storage systems.
Storage Administrator (Local Copy)
POST base-URL/v1/services/snapshot-tree/actions/delete-garbage-data/invoke
Object ID
None.
Query parameters
None.
Body
{ "parameters": { "ldevId": 66, "operationType": "start" } }
Attribute
Type
Description
ldevId
int
(Required) LDEV number of the root volume
operationType
string
(Required) Starts or stops the deletion of garbage data.
The following values can be specified:
- start: Starts the processing for deleting garbage data
- stop: Stops the processing for deleting garbage data
Body
A job object is returned. For details on attributes other than
affectedResources
, see the section that explains job objects.Attribute
Description
affectedResources
URL of the root volume
To check whether garbage data has been deleted from a snapshot tree, do not check the job status. Instead, get the attributes of the volume to check the status of the processing for deleting the garbage data.
The processing to delete garbage data stops automatically when the remaining amount of garbage data is less than 1 GB.
In some cases, the processing to delete garbage data stops even if the remaining amount of garbage data is 1 GB or more. In such cases, rerun the processing to delete garbage data, so that the remaining amount of garbage data becomes less than 1 GB.
None.
For details about the status codes issued in response to requests for this operation, see the description of HTTP status codes.
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/services/snapshot-tree/actions/delete-garbage-data/invoke
Cloning pairs in a specified snapshot group
Storage Administrator (Local Copy)
POST base-URL/v1/objects/snapshot-groups/object-ID/actions/clone/invoke
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 cloned belong
Specify a character string consisting of 1 to 32 characters. The name is case sensitive.
Query parameters
None.
Body
{ "parameters": { "copySpeed": "medium" } }
Attribute
Type
Description
copySpeed
string
(Optional) Specify the copy speed.
You can specify the following values:
- slower: Low speed
- medium: Medium speed
- faster: High speed
This item is not case sensitive.
If you do not specify this item, medium will be set.
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 snapshot group that was cloned
GET base-URL/v1/objects/snapshot-groups/object-ID/actions/clone
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 indicates that the specified snapshot group cannot be cloned. |
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/clone
To run the request after getting an action template:
curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" --data-binary @./InputParameters.json -X POST https://192.0.2.100/ConfigurationManager/v1/objects/snapshot-groups/snapshotGroup/actions/clone/invoke
Cloning a Thin Image pair
Storage Administrator (Local Copy)
POST base-URL/v1/objects/snapshots/object-ID/actions/clone/invoke
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 cloned
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 cloned
Specify a value in the range from 0 to 1023.
Query parameters
None.
Body
{ "parameters": { "copySpeed": "medium" } }
Attribute
Type
Description
copySpeed
string
(Optional) Specify the copy speed.
You can specify the following values:
- slower: Low speed
- medium: Medium speed
- faster: High speed
This item is not case sensitive.
If you do not specify this item, medium will be set.
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 Thin Image pair that was cloned
GET base-URL/v1/objects/snapshots/object-ID/actions/clone
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 indicates that the specified pair cannot be cloned. |
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/clone
To run the request after getting an action template:
curl -v -H "Accept: application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" --data-binary @./InputParameters.json -X POST https://192.0.2.100/ConfigurationManager/v1/objects/snapshots/100,3/actions/clone/invoke