MENU
      getSubnetList

        getSubnetList


        기사 요약

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

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

        요청

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

        메서드URI
        GET, POST/getSubnetList

        요청 헤더

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

        요청 쿼리 파라미터

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

        필드타입필수 여부설명
        regionCodeStringOptionalSubnet 목록을 조회하려는 리전 코드
      • 조회 결과의 첫 번째 리전(기본값)
      • getRegionList를 통해 확인
      • subnetNoList.NList<String>OptionalSubnet 번호로 목록 조회
      • subnetNogetSubnetList를 통해 확인
      • <예시> subnetNoList.1=1234&subnetNoList.2=2345
      • subnetNameStringOptionalSubnet 이름으로 목록 조회
        subnetStringOptionalSubnet IP 주소 범위로 목록 조회
      • <예시>subnet=10.0.0.0/24
      • subnetTypeCodeStringOptionalSubnet 유형 코드로 목록 조회
        • PUBLIC | PRIVATE
        usageTypeCodeStringOptionalSubnet 용도 유형 코드로 Subnet 목록 조회
        • GEN| LOADB | BM | NATGW
          • GEN: 일반
          • LOADB: 로드밸런서 전용
          • BM: 베어메탈 전용
          • NATGW: NAT Gateway 전용
        networkAclNoStringOptionalSubnet에 적용된 Network ACL 번호로 Subnet 목록 조회
      • networkAclNogetNetworkAclList를 통해 확인
      • pageNoIntegerOptional페이징된 결과의 페이지 번호
        • pageNo, pageSize를 이용하여 결과값을 페이징 처리
        pageSizeIntegerConditional페이징 시 보여줄 각 페이지 크기
        • pageNo 입력 시 필수
        • pageNo, pageSize를 이용하여 결과값을 페이징 처리
        subnetStatusCodeStringOptionalSubnet 상태 코드로 Subnet 목록 조회
        • INIT | CREATING | RUN | TERMTING
        vpcNoStringOptionalVPC 번호로 Subnet 목록 조회
        zoneCodeStringOptional존 코드로 Subnet 목록 조회
        responseFormatTypeStringOptional응답 결과의 형식
        • xml (기본값) | json

        요청 예시

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

        curl --location 'https://ncloud.apigw.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}'
        Curl

        응답

        응답 형식을 설명합니다.

        응답 바디

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

        응답 상태 코드

        네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 Ncloud 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>
        XML

        이 문서가 도움이 되었습니까?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.