getNasVolumeInstanceList

개요

NAS 볼륨 인스턴스 리스트를 조회합니다.

요청

요청 파라미터

파라미터명 필수 여부 타입 제약 사항 설명
regionCode No String 리전 코드
NAS 볼륨 인스턴스 리스트가 조회될 리전(Region)을 결정할 수 있습니다.
regionCode는 getRegionList 액션을 통해서 획득할 수 있습니다.
Default : getRegionList 조회 결과의 첫 번째 리전을 선택
zoneCode No String ZONE 코드
NAS 볼륨 인스턴스 리스트가 조회될 존(zone)을 결정할 수 있습니다.
zoneCode는 getZoneList 액션을 통해서 획득할 수 있습니다.
nasVolumeInstanceNoList.N No List<String> NAS 볼륨 인스턴스 번호 리스트
NAS 볼륨 인스턴스 번호로 필터링하여 검색할 수 있습니다.
nasVolumeInstanceNo는 getNasVolumeInstanceList 액션을 통해서 획득할 수 있습니다.
ex) nasVolumeInstanceNoList.1=1234&nasVolumeInstanceNoList.2=2345
volumeName No String 볼륨 이름
NAS 볼륨 이름으로 필터링하여 검색할 수 있습니다.
volumeAllotmentProtocolTypeCode No String 볼륨 할당 프로토콜 유형 코드
볼륨 할당 프로토콜 유형으로 필터링하여 검색할 수 있습니다.
Options : NFS (CentOS, Ubuntu 등 리눅스 서버에서 마운트할 수 있습니다.) | CIFS (Windows 서버에서 마운트할 수 있습니다.)
isEventConfiguration No Boolean 이벤트 설정 여부
이벤트 설정 여부로 필터링하여 검색할 수 있습니다.
Options : true | false
isSnapshotConfiguration No Boolean 스냅샷 설정 여부
스냅샷 설정 여부로 필터링하여 검색할 수 있습니다.
Options : true | false
pageNo No Integer 페이징된 결과의 페이지 번호
결과값을 pageNo, pageSize를 이용하여 페이징 처리를 할 수 있습니다.
pageSize Conditional Integer 페이징 시 보여줄 각 페이지 사이즈
결과값을 pageNo, pageSize를 이용하여 페이징 처리를 할 수 있습니다.
pageNo 입력시 반드시 입력합니다.
sortedBy No String 정렬 대상
결과값을 NAS 볼륨 인스턴스 번호, 볼륨 이름, 볼륨 총 사이즈로 정렬할 수 있습니다.
Options : nasVolumeInstanceNo | volumeName | volumeTotalSize
sortingOrder No String 정렬 순서
sortedBy 이용시 오름차순/내림차순 정렬을 설정합니다.
Options : ASC (오름차순) | DESC (내림차순)
Default : ASC
responseFormatType No String 응답 결과의 포맷 타입
Options : xml | json
Default : xml

응답

응답 바디

예시

요청 예시

GET {API_URL}/vnas/v2/getNasVolumeInstanceList
?regionCode=KR
&zoneCode=KR-1
&nasVolumeInstanceNoList.1=***3901
&volumeName=n***4567_test***
&volumeAllotmentProtocolTypeCode=NFS
&isEventConfiguration=false
&isSnapshotConfiguration=false

응답 예시

<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>
      <volumeUseSize>655360</volumeUseSize>
      <volumeUseRatio>0.0</volumeUseRatio>
      <snapshotVolumeConfigurationRatio>0.0</snapshotVolumeConfigurationRatio>
      <snapshotVolumeConfigTime>0</snapshotVolumeConfigTime>
      <snapshotVolumeSize>0</snapshotVolumeSize>
      <snapshotVolumeUseSize>0</snapshotVolumeUseSize>
      <snapshotVolumeUseRatio>0.0</snapshotVolumeUseRatio>
      <isSnapshotConfiguration>false</isSnapshotConfiguration>
      <isEventConfiguration>false</isEventConfiguration>
      <regionCode>KR</regionCode>
      <zoneCode>KR-1</zoneCode>
      <nasVolumeServerInstanceNoList/>
      <isEncryptedVolume>false</isEncryptedVolume>
    </nasVolumeInstance>
  </nasVolumeInstanceList>
</getNasVolumeInstanceListResponse>