restoreNasVolumeWithSnapshot

Prev Next

Available in Classic

You can use a snapshot to restore a NAS volume.

Note
  • After you restore a NAS volume, you can view the recovery history on that volume.
  • When you restore a NAS volume, only the snapshot used for recovery and any snapshots created before it are retained; snapshots created after the point of recovery are lost.

Requests

The following describes the request format for the endpoint. The request format is as follows.

Method URI
GET, POST /restoreNasVolumeWithSnapshot

Request headers

For headers common to all NAS APIs, see NAS common headers.

Request query parameters

The following describes the parameters.

Field Type Required Description
nasVolumeInstanceNo String Required Unique number of the NAS volume instance to be restored
nasVolumeSnapshotName String Required Name of the snapshot to be used for recovery

Request example

The following is a sample request.

curl --location --request GET 'https://ncloud.apigw.ntruss.com/server/v2/restoreNasVolumeWithSnapshot?nasVolumeInstanceNo=00000000&nasVolumeSnapshotName=now.20240403.164335' \
--header 'x-ncp-apigw-timestamp: {timestamp}' \
--header 'x-ncp-iam-access-key: {access key}' \
--header 'x-ncp-apigw-signature-v2: {API gateway signature}' \

Responses

The following describes the response format.

Response body

See NasVolumeSnapshotList for the response body.

Response status codes

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

The following is a sample response. The snapshot list of the corresponding NAS volume instance is displayed after completing the request.

<?xml version="1.0" encoding="UTF-8"?>
<restoreNasVolumeWithSnapshotResponse>
    <requestId></requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <nasVolumeSnapshotList>
        <nasVolumeSnapshot>
            <nasVolumeSnapshotName>now.20240403.164335</nasVolumeSnapshotName>
            <createDate>2024-04-03T16:43:35+0900</createDate>
            <snapshotSize>290816</snapshotSize>
            <isBusy>false</isBusy>
        </nasVolumeSnapshot>
    </nasVolumeSnapshotList>
</restoreNasVolumeWithSnapshotResponse>