getNasVolumeInstanceList
- Print
- PDF
getNasVolumeInstanceList
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Can be used in a VPC environment.
Overview
Query the list of NAS volume instances.
Request
Request parameter
| Parameter Name | Required Status | Type | Restrictions | Description |
|---|---|---|---|---|
| regionCode | No | String | Region Code You can decide the region where the list of NAS volume instances will be queried. The regionCode can be obtained through the getRegionList action. Default: Select the first region of the getRegionList query results. | |
| zoneCode | No | String | ZONE Code You can decide the zone in which the list of NAS volume instances will be queried. The zoneCode can be obtained through the getZoneList action. | |
| nasVolumeInstanceNoList.N | No | List<String> | List of the NAS volume instance numbers You can search by filtering with the NAS volume instance number. The nasVolumeInstanceNo can be obtained through the getNasVolumeInstanceList action. ex) --nasVolumeInstanceNoList 1234 2345 | |
| volumeName | No | String | Volume name You can search by filtering with an NAS volume name. | |
| volumeAllotmentProtocolTypeCode | No | String | Type code of volume allocation protocol You can search by filtering with the volume allocation protocol type. Options: NFS (can be mounted on Linux servers, such as CentOS, Ubuntu, etc.) | CIFS (can be mounted on Windows server) | |
| isEventConfiguration | No | Boolean | Event setting status You can search by filtering with the event setting status. Options : true | false | |
| isSnapshotConfiguration | No | Boolean | Snapshot setting status You can search by filtering with the snapshot setting status. Options : true | false | |
| pageNo | No | Integer | The page number of the paged results The results can shown as pages using pageNo and pageSize. | |
| pageSize | Conditional | Integer | The size of each page to be displayed at the time of paging The results can shown as pages using pageNo and pageSize. Enter it when entering pageNo. | |
| sortedBy | No | String | Sorting target The results can be sorted by the NAS volume instance number, volume name, and total volume size. Options : nasVolumeInstanceNo | volumeName | volumeTotalSize | |
| sortingOrder | No | String | Sorting order When using sortedBy, set sorting in ascending /descending order. Options: ASC (ascending order) | DESC (descending order) Default : ASC | |
| responseFormatType | No | String | Format type for the response result Options : xml | json Default : xml |
Response
Response data type
- NasVolumeInstanceList type
| NasVolumeInstanceList extends CommonResponse |
|---|
| private Integer totalRows; |
| private List<NasVolumeInstance> nasVolumeInstanceList = new ArrayList<>(); |
| NasVolumeInstance |
|---|
| private String nasVolumeInstanceNo; |
| private CommonCode nasVolumeInstanceStatus; |
| private CommonCode nasVolumeInstanceOperation; |
| private String nasVolumeInstanceStatusName; |
| private Date createDate; |
| private String nasVolumeDescription; |
| private String mountInformation; |
| private CommonCode volumeAllotmentProtocolType; |
| private String volumeName; |
| private Long volumeTotalSize; |
| private Long volumeSize; |
| private Float snapshotVolumeConfigurationRatio; |
| private CommonCode snapshotVolumeConfigPeriodType; |
| private CommonCode snapshotVolumeConfigDayOfWeekType; |
| private Integer snapshotVolumeConfigTime; |
| private Long snapshotVolumeSize; |
| private Boolean isSnapshotConfiguration; |
| private Boolean isEventConfiguration; |
| private String regionCode; |
| private String zoneCode; |
| private ServerInstanceNoList nasVolumeServerInstanceNoList; |
| private Boolean isEncryptedVolume; |
| private List<NasVolumeInstanceCustomIp> nasVolumeInstanceCustomIpList; |
| private Boolean isReturnProtection; |
| NasVolumeInstanceCustomIp |
|---|
| private String customIp; |
Example
Request example
ncloud vnas getNasVolumeInstanceList --regionCode KR --zoneCode KR-1 --nasVolumeInstanceNoList ***3901 --volumeName n***4567_test*** --volumeAllotmentProtocolTypeCode NFS --isEventConfiguration false --isSnapshotConfiguration false
Response example
<getNasVolumeInstanceListResponse>
<requestId>988048d6-30c6-4783-b2c9-bd2436d0db93</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<nasVolumeInstanceList>
<nasVolumeInstance>
<nasVolumeInstanceNo>***3901</nasVolumeInstanceNo>
<nasVolumeInstanceStatus>
<code>CREAT</code>
<codeName>NAS create</codeName>
</nasVolumeInstanceStatus>
<nasVolumeInstanceOperation>
<code>NULL</code>
<codeName>NAS NULL OP</codeName>
</nasVolumeInstanceOperation>
<nasVolumeInstanceStatusName></nasVolumeInstanceStatusName>
<createDate>1970-01-01T09:00:02+0900</createDate>
<nasVolumeDescription></nasVolumeDescription>
<mountInformation>***.***.0.20:/n***4567_test***</mountInformation>
<volumeAllotmentProtocolType>
<code>NFS</code>
<codeName>NFS</codeName>
</volumeAllotmentProtocolType>
<volumeName>n***4567_test***</volumeName>
<volumeTotalSize>536870912000</volumeTotalSize>
<volumeSize>536870912000</volumeSize>
<snapshotVolumeConfigurationRatio>0.0</snapshotVolumeConfigurationRatio>
<snapshotVolumeConfigTime>0</snapshotVolumeConfigTime>
<snapshotVolumeSize>0</snapshotVolumeSize>
<isSnapshotConfiguration>false</isSnapshotConfiguration>
<isEventConfiguration>false</isEventConfiguration>
<regionCode>KR</regionCode>
<zoneCode>KR-1</zoneCode>
<nasVolumeServerInstanceNoList/>
<isEncryptedVolume>false</isEncryptedVolume>
<nasVolumeInstanceCustomIpList/>
<isReturnProtection>false</isReturnProtection>
</nasVolumeInstance>
</nasVolumeInstanceList>
</getNasVolumeInstanceListResponse>
Was this article helpful?