Snapshot management
GET /v1/objects/volumes/<id>/master-volume
Required Role: Security, Storage, Monitor, Service, Resource, VpsSecurity, VpsStorage, or VpsMonitor
Obtains the P-VOL information used to create this volume when snapshotAttribute of the target volume is S-VOL or P/S VOL. If this API is called when snapshotAttribute is a hyphen (-) or P-VOL, HTTP status code 404 (Not Found) is returned.
|
Name |
Description |
Type |
Data type |
|
id |
Volume ID. |
path |
string (uuid) required |
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -i -u admin:password -X GET https://192.168.1.100/ConfigurationManager/simple/v1/objects/volumes/27f8944a-e98b-490d-b8fb-14583ceabc65/master-volume
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: private, no-store, no-cache, must-revalidate
Content-Security-Policy: default-src 'self'; style-src 'self' 'unsafe-inline';
Access-Control-Allow-Methods: GET, POST, DELETE, PATCH
Access-Control-Allow-Headers: Content-Type
Content-Type: application/json
Content-Length: 215
Date: Thu, 20 Oct 2022 05:33:44 GMT
{"masterVolumeId":"35d16c28-b033-4c00-9956-67e8221493d3","vpsId":"(system)","vpsName":"(system)","qosParam":{"upperLimitForIops":-1,"upperLimitForTransferRate":-1,"upperAlertAllowableTime":-1,"upperAlertTime":null}}
Uses default content-types: application/json
200 OK
Indicates that the request was processed correctly. This status code is also returned when the deletion request was executed successfully.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that the resource specified by the URL was not found, or you are not authorized to see the resource.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
GET /v1/objects/volumes/<id>/snapshot-volumes
Required Role: Security, Storage, Monitor, Service, Resource, VpsSecurity, VpsStorage, or VpsMonitor
Obtains a list of S-VOL information items created from this volume when snapshotAttribute of the target volume is P-VOL or P/S VOL.
|
Name |
Description |
Type |
Data type |
|
id |
Volume ID. |
path |
string (uuid) required |
|
vpsId |
The ID of the virtual private storage (VPS) that the acquisition-target resource belongs to. To filter out the resources that do not belong to the VPS, specify "system". To filter the resources by the VPS that the resources belong to, specify it in UUID format. |
query |
string , must match /^system$|^[A-Fa-f0-9]{8}(-[A-Fa-f0-9]{4}){3}-[A-Fa-f0-9]{12}$/ |
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -i -u admin:password -X GET https://192.168.1.100/ConfigurationManager/simple/v1/objects/volumes/35d16c28-b033-4c00-9956-67e8221493d3/snapshot-volumes
HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: private, no-store, no-cache, must-revalidate
Content-Security-Policy: default-src 'self'; style-src 'self' 'unsafe-inline';
Access-Control-Allow-Methods: GET, POST, DELETE, PATCH
Access-Control-Allow-Headers: Content-Type
Content-Type: application/json
Content-Length: 555
Date: Thu, 20 Oct 2022 05:34:37 GMT
{"data":[{"snapshotVolumeId":"27f8944a-e98b-490d-b8fb-14583ceabc65","snapshotVolumeName":"Volume7","snapshotVolumeNickname":"system_vol","statusSummary":"Normal","status":"Normal","snapshotStatus":"Prepared","snapshotProgressRate":null,"snapshotTimestamp":null,"snapshotType":"Snapshot","snapshotConcordanceRate":100,"isWrittenInSvol":null,"vpsId":"(system)","vpsName":"(system)","qosParam":{"upperLimitForIops":-1,"upperLimitForTransferRate":-1,"upperAlertAllowableTime":-1,"upperAlertTime":null}}],"totalCount":1,"hasNext":false,"enumerateContext":null}
Uses default content-types: application/json
200 OK
Indicates that the request was processed correctly. This status code is also returned when the deletion request was executed successfully.
DESCRIPTION
A list of S-VOL information items and information about data.
PROPERTIES
data:object[]
A list of S-VOL information items.
totalCount:integer
The total number of records.
hasNext:boolean
Indicates whether there is information dropped from the data.
enumerateContext:string (uuid)nullable
A token used to obtain the remaining items for the next batch. Null is output if there are no more items to be obtained.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that the resource specified by the URL was not found, or you are not authorized to see the resource.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
POST /v1/objects/volumes/actions/create-snapshot/invoke
Required Role: Storage or VpsStorage
Creates a Snapshot.
None
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -u admin:password -i -X POST -H "Content-Type: application/json" -H "Expect:" -d '{ "masterVolumeId": "f77278ae-c86a-451d-b309-605fa63b5ff5" }' https://192.168.1.100/ConfigurationManager/simple/v1/objects/volumes/actions/create-snapshot/invoke
The following shows an example using a json body.
curl -u admin:password -i -X POST -H "Content-Type: application/json" -H "Expect:" -d @example.json https://192.168.1.100/ConfigurationManager/simple/v1/objects/volumes/actions/create-snapshot/invoke
example.json is defined as follows:
{
"masterVolumeId": "f77278ae-c86a-451d-b309-605fa63b5ff5"
}
Uses default content-types: application/json
Indicates that an asynchronous process request was accepted.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that the resource specified by the URL was not found, or you are not authorized to see the resource.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the Content-Length header must be specified. It is returned when the request body was not specified and "Content-Length: 0" was not specified as the header parameter.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that an unsupported media type was specified for the Content-Type header.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
POST /v1/objects/volumes/actions/delete-snapshot/invoke
Required Role: Storage or VpsStorage
Deletes a snapshot. You can delete a volume other than P-VOL, S-VOL or P/S-VOL only by the API for deleting a volume, not by this API.
By running the API with the S-VOL specified for snapshotVolumeId, you can delete the S-VOL. If you want to delete P/S-VOLs, perform deletion after deleting all the S-VOLs and P/S-VOLs created from the P/S-VOLs to be deleted.
When the snapshot status of the S-VOL is "Error" and deletion is unsuccessful with the S-VOL specified for snapshotVolumeId, specify the P-VOL corresponding to the S-VOL for masterVolumeId and "true" for snapshotTree, and then perform the deletion. When performing the deletion, note the following:
-
You should verify the S-VOLs and P/S-VOLs created from the specified P-VOL beforehand so that you can confirm that all the S-VOLs and P/S-VOLs have been deleted after performing the deletion. For how to confirm which are the S-VOLs and P/S-VOLs created from the P-VOL, see Obtaining a list of S-VOL information for the volume in the Hitachi Virtual Storage Software Block Storage Administrator Guide.
-
If a system configuration change operation conflicts when the API is run, the job might be unsuccessful. In this case, retry the operation.
None
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -u admin:password -i -X POST -H "Content-Type: application/json" -H "Expect:" -d '{ "snapshotVolumeId": "f8a757a0-afbd-4354-ab9a-19b8a2487080" }' https://192.168.1.100/ConfigurationManager/simple/v1/objects/volumes/actions/delete-snapshot/invoke
The following shows an example using a json body.
curl -u admin:password -i -X POST -H "Content-Type: application/json" -H "Expect:" -d @example.json https://192.168.1.100/ConfigurationManager/simple/v1/objects/volumes/actions/delete-snapshot/invoke
example.json is defined as follows:
{
"snapshotVolumeId": "f8a757a0-afbd-4354-ab9a-19b8a2487080"
}
Uses default content-types: application/json
Indicates that an asynchronous process request was accepted.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that the resource specified by the URL was not found, or you are not authorized to see the resource.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the Content-Length header must be specified. It is returned when the request body was not specified and "Content-Length: 0" was not specified as the header parameter.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that an unsupported media type was specified for the Content-Type header.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication
POST /v1/objects/volumes/actions/restore-snapshot/invoke
Required Role: Storage or VpsStorage
Restores the volume from the snapshot.
Performing restoration changes the snapshot status of the restoration-source S-VOL to Prepared. The status changes to Restoring first, and then to Prepared.
None
The following example shows how a REST API is executed by using curl for Virtual Storage Software block at IP address 192.168.1.100 with the user name as admin and the password as password.
curl -u admin:password -i -X POST -H "Content-Type: application/json" -H "Expect:" -d '{ "snapshotVolumeId": "deb8971d-3c7a-4147-adc6-e20a2504b3e8" }' https://192.168.1.100/ConfigurationManager/simple/v1/objects/volumes/actions/restore-snapshot/invoke
The following shows an example using a json body.
curl -u admin:password -i -X POST -H "Content-Type: application/json" -H "Expect:" -d @example.json https://192.168.1.100/ConfigurationManager/simple/v1/objects/volumes/actions/restore-snapshot/invoke
example.json is defined as follows:
{
"snapshotVolumeId": "deb8971d-3c7a-4147-adc6-e20a2504b3e8"
}
Uses default content-types: application/json
Indicates that an asynchronous process request was accepted.
Indicates that the request header, query parameter, and request body are incorrect.
Indicates that no Authorization header is specified for the request header, authentication using the information specified for the Authorization header was unsuccessful, or authentication using a parameter was unsuccessful.
Indicates that you are not authorized to perform the operation.
Indicates that the resource specified by the URL was not found, or you are not authorized to see the resource.
Indicates that an unsupported media type was specified for the Accept header.
Indicates that the Content-Length header must be specified. It is returned when the request body was not specified and "Content-Length: 0" was not specified as the header parameter.
Indicates that the size of the request body exceeds the acceptable upper limit.
Indicates that an unsupported media type was specified for the Content-Type header.
Indicates that the Expect header is specified incorrectly, or the REST API server does not support the Expect header.
Indicates that the size of the request header exceeds the acceptable upper limit.
Indicates that an internal error occurred on the REST API server or in the target storage cluster.
Indicates that an internal error occurred on the REST API server.
Indicates that the request cannot be received because the REST API server or the target storage cluster is busy. This is a temporary problem, and the request might be processed normally if it is executed again after a while.
Indicates that the REST API server did not respond.
-
basic authentication
-
session authentication