changeNasVolumeSnapshotConfiguration

Available in VPC

Change the snapshot configuration for the NAS volume instance.

Syntax

The changeNasVolumeSnapshotConfiguration syntax is as follows:

./ncloud vnas changeNasVolumeSnapshotConfiguration \
    --nasVolumeInstanceNo <nas-volume-instance-no> \
    --snapshotVolumeConfigurationRatio <snapshot-volume-configuration-ratio> \
    [--snapshotVolumeConfigDayOfWeekTypeCode <-1|0|1|2|3|4|5|6>] \
    [--snapshotVolumeConfigTime <snapshot-volume-config-time>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running changeNasVolumeSnapshotConfiguration.

Required options

The following options are required for changeNasVolumeSnapshotConfiguration.

Options	Type	Required	Description
`--nasVolumeInstanceNo`	String	Required	NAS volume instance number See getNasVolumeInstanceList.
`--snapshotVolumeConfigurationRatio`	Integer	Required	Snapshot allocation ratio within the volume (%) `0`-`99` Setting to `0` disables snapshots. If the snapshot capacity exceeds the set ratio, snapshots are deleted starting with the oldest ones.
`--snapshotVolumeConfigTime`	Integer	Conditional	Execution time for automatic snapshot creation (hour) `0`-`23` Required if `snapshotVolumeConfigDayOfWeekTypeCode` is entered

Optional options

These are the optional options for changeNasVolumeSnapshotConfiguration. Options that are not specified will use their default values.

Options	Type	Required	Description
`--snapshotVolumeConfigDayOfWeekTypeCode`	String	Optional	Enables automatic snapshot creation and sets the schedule. `-1` (daily) \| `0` (Sunday) \| `1` (Monday) \| `2` (Tuesday) \| `3` (Wednesday) \| `4` (Thursday) \| `5` (Friday) \| `6` (Saturday) If the snapshot allocation ratio is `0`, this option is invalid. Snapshots are automatically created on the specified days within the snapshot capacity limit.

Common options

For information about the options common to all vnas subcommands, see NAS (VPC) options.

Examples

If the request to change the snapshot settings is successful, the configuration information for the NAS volume instance and the snapshot settings are returned.

Command

The command example is as follows:

./ncloud vnas changeNasVolumeSnapshotConfiguration \
    --nasVolumeInstanceNo 10234567 \
    --snapshotVolumeConfigurationRatio 10 \
    --snapshotVolumeConfigDayOfWeekTypeCode -1 \
    --snapshotVolumeConfigTime 1 \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "changeNasVolumeSnapshotConfigurationResponse": {
    "totalRows": 1,
    "nasVolumeInstanceList": [
      {
        "nasVolumeInstanceNo": "10234567",
        "nasVolumeInstanceStatus": {
          "code": "CREAT",
          "codeName": "NAS creation status"
        },
        "nasVolumeInstanceOperation": {
          "code": "NULL",
          "codeName": "NAS NULL OP"
        },
        "nasVolumeInstanceStatusName": "created",
        "createDate": "2026-08-19T11:32:32+0900",
        "nasVolumeDescription": "Test NAS volume",
        "mountInformation": "192.0.2.10:/n123456_testnas01",
        "volumeAllotmentProtocolType": {
          "code": "NFS",
          "codeName": "NFS"
        },
        "volumeName": "n123456_testnas01",
        "volumeTotalSize": 536870912000,
        "volumeSize": 483183820800,
        "snapshotVolumeConfigurationRatio": 10.0,
        "snapshotVolumeConfigPeriodType": {
          "code": "DAY",
          "codeName": "Daily"
        },
        "snapshotVolumeConfigDayOfWeekType": {
          "code": "-1",
          "codeName": "Everyday"
        },
        "snapshotVolumeConfigTime": 1,
        "snapshotVolumeSize": 53687091200,
        "isSnapshotConfiguration": true,
        "isEventConfiguration": false,
        "regionCode": "KR",
        "zoneCode": "KR-2",
        "nasVolumeServerInstanceNoList": [],
        "isEncryptedVolume": false,
        "nasVolumeInstanceCustomIpList": [],
        "isReturnProtection": false
      }
    ],
    "requestId": "",
    "returnCode": "0",
    "returnMessage": "success"
  }
}