createNasVolumeSnapshot

Prev Next

Available in VPC

Create a snapshot of a NAS volume instance.

Note

Before running the createNasVolumeSnapshot API, check the capacity information of the snapshot. f the capacity allocated for the snapshot is exceeded after running the API, the snapshot may not be created or past snapshots may be deleted.

Requests

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

Method URI
GET, POST /createNasVolumeSnapshot

Request headers

For headers common to all NAS (VPC) APIs, see NAS (VPC) common headers.

Request query parameters

The following describes the parameters.

Field Type Required Description
nasVolumeInstanceNo String Required Unique number of the NAS volume instance
regionCode String Optional Region code
responseFormatType String Optional Format type of the response result
  • xml (default) | json

Request example

The following is a sample request.

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vnas/v2/createNasVolumeSnapshot?nasVolumeInstanceNo=00000000&regionCode=KR&responseFormatType=xml' \
--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.

<?xml version="1.0" encoding="UTF-8"?>
<createNasVolumeSnapshotResponse>
    <requestId></requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>2</totalRows>
    <nasVolumeSnapshotList>
        <nasVolumeSnapshot>
            <nasVolumeSnapshotName>now.20240403.132523</nasVolumeSnapshotName>
            <createDate>2024-04-03T13:25:23+0900</createDate>
            <snapshotSize>0</snapshotSize>
            <isBusy>false</isBusy>
        </nasVolumeSnapshot>
        <nasVolumeSnapshot>
            <nasVolumeSnapshotName>now.20240403.132209</nasVolumeSnapshotName>
            <createDate>2024-04-03T13:22:09+0900</createDate>
            <snapshotSize>147456</snapshotSize>
            <isBusy>false</isBusy>
        </nasVolumeSnapshot>
    </nasVolumeSnapshotList>
</createNasVolumeSnapshotResponse>