MENU
      changeNasVolumeSnapshotConfiguration

        changeNasVolumeSnapshotConfiguration


        Article summary

        Available in VPC

        Change the snapshot settings for a NAS volume instance.

        Requests

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

        MethodURI
        GET, POST/changeNasVolumeSnapshotConfiguration

        Request headers

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

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        nasVolumeInstanceNoStringRequiredUnique number of the NAS volume instance
        snapshotVolumeConfigurationRatioIntegerRequiredSet the percentage of snapshot allocation in the volume (%)
        • 0 - 99
        • If the snapshot capacity exceeds the set percentage of capacity, it deletes past snapshots first
        • Setting to 0 disables snapshots
        regionCodeStringOptionalRegion code
        snapshotVolumeConfigDayOfWeekTypeCodeStringOptionalEnable automatic snapshot creation and set the frequency
      • -1 (daily) | 0 (Sunday) | 1 (Monday) | 2 (Tuesday) | 3 (Wednesday) | 4 (Thursday) | 5 (Friday) | 6 (Saturday)
        • Invalid if snapshot allocation percentage is zero
        • Create automatically by day of week as set within snapshot capacity limits
      • snapshotVolumeConfigTimeIntegerConditionalExecution time (hour) for automatic snapshot creation
        • 0 - 23
        • Setup required if automatic snapshot creation is enabled
        responseFormatTypeStringOptionalFormat 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/changeNasVolumeSnapshotConfiguration?regionCode=KR&nasVolumeInstanceNo=00000000&snapshotVolumeConfigurationRatio=3&snapshotVolumeConfigDayOfWeekTypeCode=6&snapshotVolumeConfigTime=0&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}' \
        Curl

        Responses

        The following describes the response format.

        Response body

        See NasVolumeInstanceList 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"?>
        <changeNasVolumeSnapshotConfigurationResponse>
            <requestId></requestId>
            <returnCode>0</returnCode>
            <returnMessage>success</returnMessage>
            <totalRows>1</totalRows>
            <nasVolumeInstanceList>
                <nasVolumeInstance>
                    <nasVolumeInstanceNo>00000000</nasVolumeInstanceNo>
                    <nasVolumeInstanceStatus>
                        <code>CREAT</code>
                        <codeName>NAS create</codeName>
                    </nasVolumeInstanceStatus>
                    <nasVolumeInstanceOperation>
                        <code>NULL</code>
                        <codeName>NAS NULL OP</codeName>
                    </nasVolumeInstanceOperation>
                    <nasVolumeInstanceStatusName>created</nasVolumeInstanceStatusName>
                    <createDate>2024-04-03T13:07:16+0900</createDate>
                    <nasVolumeDescription></nasVolumeDescription>
                    <mountInformation>101.101.00.00:/n0000000_hss</mountInformation>
                    <volumeAllotmentProtocolType>
                        <code>NFS</code>
                        <codeName>NFS</codeName>
                    </volumeAllotmentProtocolType>
                    <volumeName>n0000000_hss</volumeName>
                    <volumeTotalSize>536870912000</volumeTotalSize>
                    <volumeSize>520764784640</volumeSize>
                    <snapshotVolumeConfigurationRatio>3.0</snapshotVolumeConfigurationRatio>
                    <snapshotVolumeConfigPeriodType>
                        <code>WEEK</code>
                        <codeName>everyweek</codeName>
                    </snapshotVolumeConfigPeriodType>
                    <snapshotVolumeConfigDayOfWeekType>
                        <code>6</code>
                        <codeName>Saturday</codeName>
                    </snapshotVolumeConfigDayOfWeekType>
                    <snapshotVolumeConfigTime>0</snapshotVolumeConfigTime>
                    <snapshotVolumeSize>16106127360</snapshotVolumeSize>
                    <isSnapshotConfiguration>true</isSnapshotConfiguration>
                    <isEventConfiguration>false</isEventConfiguration>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-2</zoneCode>
                    <nasVolumeServerInstanceNoList/>
                    <isEncryptedVolume>false</isEncryptedVolume>
                    <nasVolumeInstanceCustomIpList/>
                    <isReturnProtection>false</isReturnProtection>
                </nasVolumeInstance>
            </nasVolumeInstanceList>
        </changeNasVolumeSnapshotConfigurationResponse>
        XML

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.