setNasVolumeAccessControl

Prev Next

VPC環境で利用できます。

既存の NASボリュームインスタンスのアクセス制御を削除し、新たに設定します。

構文

setNasVolumeAccessControl構文は次の通りです。

./ncloud vnas setNasVolumeAccessControl \
    --nasVolumeInstanceNo <nas-volume-instance-no> \
    --accessControlRuleList <access-control-rule-config> \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

オプション

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

必須オプション

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

オプション タイプ 必須の有無 説明
--nasVolumeInstanceNo String Required NASボリュームインスタンス番号
  • ボリューム割り当てプロトコルのタイプが NFSである NASボリュームインスタンスのみアクセス制御を設定可能
  • getNasVolumeInstanceListを参照
--accessControlRuleList List Required アクセス制御ルールリスト
  • 各ルールは、二重引用符の中に{フィールド=‘値’}のペアをコンマで区切って入力
    • serverInstanceNo (必須): アクセス制御として設定するサーバインスタンス番号。getServerInstanceListを参照
    • writeAccess (任意): 書き込み権限。true (デフォルト) | false

共通オプション

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

例

アクセス制御設定リクエストが成功すると、NASボリュームインスタンスの構成情報と新たに設定されたアクセス許可サーバ情報が返されます。

コマンド

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

./ncloud vnas setNasVolumeAccessControl \
    --nasVolumeInstanceNo 10234567 \
    --accessControlRuleList "serverInstanceNo='34567890', writeAccess='true'" \
    --regionCode KR \
    --output json

出力

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

{
  "setNasVolumeAccessControlResponse": {
    "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": [
          "34567890"
        ],
        "isEncryptedVolume": false,
        "nasVolumeInstanceCustomIpList": [],
        "isReturnProtection": false
      }
    ],
    "requestId": "",
    "returnCode": "0",
    "returnMessage": "success"
  }
}