getNasVolumeInstanceList

Available in VPC

Get the list of NAS volume instances.

Syntax

The getNasVolumeInstanceList syntax is as follows:

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

Options

This section describes the options available when running getNasVolumeInstanceList.

Required options

The following options are required for getNasVolumeInstanceList.

Options	Type	Required	Description
`--pageSize`	Integer	Conditional	Page size to display when paginating `1`-N Required when entering `pageNo`

Optional options

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

Options	Type	Required	Description
`--zoneCode`	String	Optional	Zone code See getZoneList.
`--nasVolumeInstanceNoList`	List	Optional	NAS volume instance ID list You can enter multiple items separated by spaces (e.g., `--nasVolumeInstanceNoList 1234 2345`).
`--volumeName`	String	Optional	NAS volume name
`--volumeAllotmentProtocolTypeCode`	String	Optional	NAS volume allocation protocol type code `NFS` \| `CIFS` `NFS`: It can be mounted on Linux servers such as CentOS and Ubuntu `CIFS`: It can be mounted on Windows Servers
`--isEventConfiguration`	Boolean	Optional	Whether events are set `true` \| `false` `true`: Set `false`: Not set
`--isSnapshotConfiguration`	Boolean	Optional	Whether snapshots are set `true` \| `false` `true`: Set `false`: Not set
`--pageNo`	Integer	Optional	Page numbers in paged results `1`-N
`--sortedBy`	String	Optional	Sort target `nasVolumeInstanceNo` \| `volumeName` \| `volumeTotalSize` `nasVolumeInstanceNo`: NAS volume instance number `volumeName`: Volume name `volumeTotalSize`: Total volume size
`--sortingOrder`	String	Optional	Sort order `ASC` (default) \| `DESC` `ASC`: Ascending order `DESC`: Descending order

Common options

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

Examples

If the request to retrieve the list of NAS volume instances is successful, the configuration information and snapshot settings for each instance are returned.

Command

The command example is as follows:

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

Output

The output example is as follows:

{
  "getNasVolumeInstanceListResponse": {
    "totalRows": 2,
    "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
      },
      {
        "nasVolumeInstanceNo": "10234568",
        "nasVolumeInstanceStatus": {
          "code": "CREAT",
          "codeName": "NAS creation status"
        },
        "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"
  }
}