getNasVolumeInstanceList

VPC環境で利用できます。

NASボリュームインスタンスリストを照会します。

構文

getNasVolumeInstanceList構文は次の通りです。

./ncloud vnas getNasVolumeInstanceList \
    [--zoneCode <zone-code>] \
    [--nasVolumeInstanceNoList <nas-volume-instance-no-list>] \
    [--volumeName <volume-name>] \
    [--volumeAllotmentProtocolTypeCode <NFS|CIFS>] \
    [--isEventConfiguration <true|false>] \
    [--isSnapshotConfiguration <true|false>] \
    [--pageNo <page-no>] \
    [--pageSize <page-size>] \
    [--sortedBy <nasVolumeInstanceNo|volumeName|volumeTotalSize>] \
    [--sortingOrder <ASC|DESC>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

オプション

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

必須オプション

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

オプション	タイプ	必須の有無	説明
`--pageSize`	Integer	Conditional	ページング時に表示する各ページのサイズ `1`~N `pageNo`入力時、必ず入力

任意オプション

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

オプション	タイプ	必須の有無	説明
`--zoneCode`	String	Optional	ゾーンコード getZoneListを参照
`--nasVolumeInstanceNoList`	List	Optional	NASボリュームインスタンス番号リストスペースで区切って複数入力可能 (例: `--nasVolumeInstanceNoList 1234 2345`)
`--volumeName`	String	Optional	NASボリューム名
`--volumeAllotmentProtocolTypeCode`	String	Optional	NASボリューム割り当てプロトコルタイプコード `NFS` \| `CIFS` `NFS`: CentOS、Ubuntuなど Linuxサーバでマウント可能 `CIFS`: Windows Serverでマウント可能
`--isEventConfiguration`	Boolean	Optional	イベントを設定するかどうか `true` \| `false` `true`: 設定 `false`: 設定しない
`--isSnapshotConfiguration`	Boolean	Optional	スナップショットを設定するかどうか `true` \| `false` `true`: 設定 `false`: 設定しない
`--pageNo`	Integer	Optional	ページングされた結果のページ番号 `1`~N
`--sortedBy`	String	Optional	ソート対象 `nasVolumeInstanceNo` \| `volumeName` \| `volumeTotalSize` `nasVolumeInstanceNo`: NASボリュームインスタンス番号 `volumeName`: ボリューム名 `volumeTotalSize`: ボリュームの総容量
`--sortingOrder`	String	Optional	ソート順序 `ASC` (デフォルト) \| `DESC` `ASC`: 昇順 `DESC`: 降順

共通オプション

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

例

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

コマンド

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

./ncloud vnas getNasVolumeInstanceList \
    --nasVolumeInstanceNoList 10234567 10234568 \
    --volumeAllotmentProtocolTypeCode NFS \
    --isEventConfiguration false \
    --pageNo 1 \
    --pageSize 10 \
    --sortedBy nasVolumeInstanceNo \
    --sortingOrder ASC \
    --regionCode KR \
    --output json

出力

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

{
  "getNasVolumeInstanceListResponse": {
    "totalRows": 2,
    "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
      },
      {
        "nasVolumeInstanceNo": "10234568",
        "nasVolumeInstanceStatus": {
          "code": "CREAT",
          "codeName": "NAS作成状態"
        },
        "nasVolumeInstanceOperation": {
          "code": "NULL",
          "codeName": "NAS NULL OP"
        },
        "nasVolumeInstanceStatusName": "created",
        "createDate": "2026-08-19T11:33:18+0900",
        "nasVolumeDescription": "",
        "mountInformation": "192.0.2.11:/n123456_testnas02",
        "volumeAllotmentProtocolType": {
          "code": "NFS",
          "codeName": "NFS"
        },
        "volumeName": "n123456_testnas02",
        "volumeTotalSize": 536870912000,
        "volumeSize": 536870912000,
        "snapshotVolumeConfigurationRatio": 0.0,
        "snapshotVolumeSize": 0,
        "isSnapshotConfiguration": false,
        "isEventConfiguration": false,
        "regionCode": "KR",
        "zoneCode": "KR-1",
        "nasVolumeServerInstanceNoList": [],
        "isEncryptedVolume": false,
        "nasVolumeInstanceCustomIpList": [],
        "isReturnProtection": false
      }
    ],
    "requestId": "",
    "returnCode": "0",
    "returnMessage": "success"
  }
}