changeNasVolumeSnapshotConfiguration

Prev Next

VPC環境で利用できます。

NASボリュームインスタンスのスナップショット設定を変更します。

構文

changeNasVolumeSnapshotConfiguration構文は次の通りです。

./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>]

オプション

changeNasVolumeSnapshotConfigurationの実行時に指定できるオプションについて説明します。

必須オプション

changeNasVolumeSnapshotConfigurationの必須オプションです。

オプション タイプ 必須の有無 説明
--nasVolumeInstanceNo String Required NASボリュームインスタンス番号
--snapshotVolumeConfigurationRatio Integer Required ボリューム内スナップショット割り当ての割合 (%)
  • 0~99
  • 0に設定すると、スナップショット設定を解除
  • スナップショットの容量が設定した割合の容量を超える場合、過去のスナップショットから削除
--snapshotVolumeConfigTime Integer Conditional スナップショット自動作成の実行時間 (時)
  • 0~23
  • snapshotVolumeConfigDayOfWeekTypeCode入力時、必ず入力

任意オプション

changeNasVolumeSnapshotConfigurationの任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

オプション タイプ 必須の有無 説明
--snapshotVolumeConfigDayOfWeekTypeCode String Optional スナップショット自動作成の有効化と周期の設定
  • -1 (毎日) | 0 (日曜日) | 1 (月曜日) | 2 (火曜日) | 3 (水曜日) | 4 (木曜日) | 5 (金曜日) | 6 (土曜日)
  • スナップショット割り当ての割合が0の場合、無効
  • スナップショット容量の制限内で設定した曜日ごとに自動作成

共通オプション

vnasコマンドで共通して使用するオプションについては、NAS (VPC)のオプションをご参照ください。

例

スナップショット設定の変更リクエストが成功すると、NASボリュームインスタンスの構成情報とスナップショット設定情報が返されます。

コマンド

コマンドの例は次の通りです。

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

出力

出力の例は次の通りです。

{
  "changeNasVolumeSnapshotConfigurationResponse": {
    "totalRows": 1,
    "nasVolumeInstanceList": [
      {
        "nasVolumeInstanceNo": "10234567",
        "nasVolumeInstanceStatus": {
          "code": "CREAT",
          "codeName": "NAS作成状態"
        },
        "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": "毎日"
        },
        "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"
  }
}