getSubnetList

VPC 환경에서 이용 가능합니다.

사용자가 지정한 조건에 따라 Subnet 목록을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET \| POST	/vpc/v2/getSubnetList

참고

가이드는 GET 방식 기준으로 안내합니다. POST 방식의 호출 테스트는 네이버 클라우드 플랫폼 콘솔의 API Gateway 서비스에서 Swagger를 통해서 가능합니다.

요청 헤더

VPC API에서 공통으로 사용하는 헤더에 대한 정보는 VPC 공통 헤더를 참조해 주십시오.

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`regionCode`	String	Optional	Subnet 목록을 조회하려는 리전 코드 조회 결과의 첫 번째 리전(기본값) getRegionList 참조
`subnetNoList.N`	List[String]	Optional	Subnet 번호로 목록 조회 `subnetNo`는 getSubnetList 참조 <예시> subnetNoList.1=1234&subnetNoList.2=2345
`subnetName`	String	Optional	Subnet 이름으로 목록 조회
`subnet`	String	Optional	Subnet IP 주소 범위로 목록 조회 <예시>`subnet`=10.0.0.0/24
`subnetTypeCode`	String	Optional	Subnet 유형 코드로 목록 조회 `PUBLIC` \| `PRIVATE`
`usageTypeCode`	String	Optional	Subnet 용도 유형 코드로 Subnet 목록 조회 `GEN`\| `LOADB` \| `BM` \| `NATGW` `GEN`: 일반 `LOADB`: 로드밸런서 전용 `BM`: 베어메탈 전용 `NATGW`: NAT Gateway 전용
`networkAclNo`	String	Optional	Subnet에 적용된 Network ACL 번호로 Subnet 목록 조회 `networkAclNo`는 getNetworkAclList 참조
`pageNo`	Integer	Optional	페이징된 결과의 페이지 번호 `pageNo`, `pageSize`를 이용하여 결과값을 페이징 처리
`pageSize`	Integer	Conditional	페이징 시 보여줄 각 페이지 크기 `pageNo` 입력 시 필수 입력 `pageNo`, `pageSize`를 이용하여 결과값을 페이징 처리
`subnetStatusCode`	String	Optional	Subnet 상태 코드로 Subnet 목록 조회 `INIT` \| `CREATING` \| `RUN` \| `TERMTING`
`vpcNo`	String	Optional	VPC 번호로 Subnet 목록 조회 getVpcList 참조
`zoneCode`	String	Optional	존 코드로 Subnet 목록 조회 getZoneList 참조
`responseFormatType`	String	Optional	응답 결과의 형식 `xml` (기본값) \| `json`

요청 예시

요청 예시는 다음과 같습니다.

curl --location 'https://ncloud.apigw.gov-ntruss.com/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' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디는 SubnetList를 참조해 주십시오.

응답 상태 코드

VPC API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 VPC API 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

<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>