VPC 환경에서 이용 가능합니다.
개요
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 1234 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 |
응답
응답 데이터 타입
- NasVolumeInstanceList 타입
| 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; |
예시
요청 예시
ncloud vnas getNasVolumeInstanceList --regionCode KR --zoneCode KR-1 --nasVolumeInstanceNoList ***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>
<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>