VPC 환경에서 이용 가능합니다.
개요
Subnet 리스트를 조회합니다.
요청
요청 파라미터
| 파라미터명 | 필수 여부 | 타입 | 제약 사항 | 설명 |
|---|---|---|---|---|
| regionCode | No | String | - 리전 코드 Subnet 리스트가 조회될 리전(Region) 결정 가능 regionCode는 getRegionList 액션을 통해 획득 가능 Default : getRegionList 조회 결과의 첫 번째 리전을 선택 |
|
| subnetNoList.N | No | List<String> | - Subnet 번호 리스트 Subnet 번호로 필터링하여 검색 가능 subnetNo는 getSubnetList 액션을 통해 획득 가능 ex) --subnetNoList 1234 2345 |
|
| subnetName | No | String | - Subnet 이름 Subnet 이름으로 필터링하여 검색 가능 |
|
| subnet | No | String | - Subnet IP 주소 범위 Subnet IP 주소 범위로 필터링하여 검색 가능 ex) --subnet 10.0.0.0/24 |
|
| subnetTypeCode | No | String | - Subnet 유형 코드 Subnet 유형 코드로 필터링하여 검색 가능 Options : PUBLIC | PRIVATE |
|
| usageTypeCode | No | String | - 용도 유형 코드 용도 유형 코드로 필터링하여 검색 가능 Options : GEN (일반) | LOADB (로드밸런서전용) | BM (베어메탈전용)| NATGW (NAT Gateway 전용) |
|
| networkAclNo | No | String | - Network ACL 번호 Subnet에 적용된 Network ACL 번호로 필터링하여 검색 가능 networkAclNo는 getNetworkAclList 액션을 통해 획득 가능 |
|
| pageNo | No | Integer | - 페이징된 결과의 페이지 번호 결과값을 pageNo, pageSize를 이용하여 페이징 처리 가능 |
|
| pageSize | Conditional | Integer | - 페이징 시 보여줄 각 페이지 사이즈 결과값을 pageNo, pageSize를 이용하여 페이징 처리 가능 pageNo 입력시 반드시 입력함 |
|
| subnetStatusCode | No | String | - Subnet 상태 코드 Subnet 상태 코드로 필터링하여 검색 가능 Options : INIT | CREATING | RUN | TERMTING |
|
| vpcNo | No | String | - VPC 번호 VPC 번호로 필터링하여 검색 가능 vpcNo는 getVpcList 액션을 통해 획득 가능 |
|
| zoneCode | No | String | - ZONE 코드 Subnet 리스트가 조회될 존(zone) 결정 가능 zoneCode는 getZoneList 액션을 통해 획득 가능 |
|
| responseFormatType | No | String | - 응답 결과의 포맷 타입 Options : xml | json Default : xml |
응답
응답 데이터 타입
- SubnetList 타입
| SubnetList extends CommonResponse |
|---|
| private Integer totalRows; |
| private List |
| Subnet |
|---|
| private String subnetNo; |
| private String vpcNo; |
| private String zoneCode; |
| private String subnetName; |
| private String subnet; |
| private CommonCode subnetStatus; |
| private Date createDate; |
| private CommonCode subnetType; |
| private CommonCode usageType; |
| private String networkAclNo; |
예시
요청 예시
ncloud vpc getSubnetList --regionCode FKR --subnetNoList ***43 --subnetName test-*** --subnet ***.***.1.0 --subnetTypeCode PUBLIC --usageTypeCode GEN --networkAclNo ***31 --subnetStatusCode RUN --vpcNo ***04 --zoneCode FKR-1
응답 예시
<getSubnetListResponse>
<requestId>4a7ca579-1b43-439b-97f7-c423a37bc3d9</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<subnetList>
<subnet>
<subnetNo>***43</subnetNo>
<vpcNo>***04</vpcNo>
<zoneCode>FKR-1</zoneCode>
<subnetName>test-***</subnetName>
<subnet>***.***.1.0/24</subnet>
<subnetStatus>
<code>RUN</code>
<codeName>run</codeName>
</subnetStatus>
<createDate>2020-05-04T11:49:52+0900</createDate>
<subnetType>
<code>PUBLIC</code>
<codeName>Public</codeName>
</subnetType>
<usageType>
<code>GEN</code>
<codeName>General</codeName>
</usageType>
<networkAclNo>***31</networkAclNo>
</subnet>
</subnetList>
</getSubnetListResponse>