Overview

Query the NAS volume instance details using the NAS volume instance number.

Request

Request parameter

Parameter Name	Required Status	Type	Description
regionCode	No	String	Region Code You can decide the region in which the NAS volume instance details will be queried. The regionCode can be obtained through the getRegionList action. Default: Select the first region of the getRegionList query results.
nasVolumeInstanceNo	Yes	String	The number of the NAS volume instances to be queried The nasVolumeInstanceNo can be obtained through the getNasVolumeInstanceList action.
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 getNasVolumeInstanceDetail --regionCode KR --nasVolumeInstanceNo ***3901

Response example

<getNasVolumeInstanceDetailResponse>
  <requestId>434a3452-d605-47b4-a10b-6e3340a8b458</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>
</getNasVolumeInstanceDetailResponse>

Was this article helpful?

Table of contents

Overview
Request
- Request parameter
Response
- Response data type
Example
- Request example
- Response example