getSubnetList

개요

Subnet 리스트를 조회합니다.

요청

요청 파라미터

파라미터명 필수 여부 타입 제약 사항 설명
regionCode No String 리전 코드
Subnet 리스트가 조회될 리전(Region)을 결정할 수 있습니다.
regionCode는 getRegionList 액션을 통해서 획득할 수 있습니다.
Default : getRegionList 조회 결과의 첫 번째 리전을 선택
subnetNoList.N No List<String> Subnet 번호 리스트
Subnet 번호로 필터링하여 검색할 수 있습니다.
subnetNo는 getSubnetList 액션을 통해서 획득할 수 있습니다.
ex) subnetNoList.1=1234&subnetNoList.2=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 (베어메탈전용)
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

응답

응답 바디

예시

요청 예시

GET {API_URL}/vpc/v2/getSubnetList
?regionCode=KR
&subnetNoList.1=***43
&subnetName=test-***
&subnet=***.***.1.0
&subnetTypeCode=PUBLIC
&usageTypeCode=GEN
&networkAclNo=***31
&subnetStatusCode=RUN
&vpcNo=***04
&zoneCode=KR-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>KR-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>