getSubnetList
    • PDF

    getSubnetList

    • PDF

    Article summary

    Available in VPC

    Overview

    Search for the list of subnets.

    Requests

    Request parameters

    Parameter nameRequirement statusTypeRestrictionsDescription
    regionCodeNoString- Region code
    Can decide the Region in which the subnet list is searched
    regionCode can be obtained via the getRegionList action.
    Default: selects the first Region of the getRegionList query results
    subnetNoList.NNoList<String>- List of the subnet numbers
    Searchable by filtering by subnet number
    subnetNo can be obtained via the getSubnetListaction.
    ex) subnetNoList.1=1234&subnetNoList.2=2345
    subnetNameNoString- Subnet name
    Searchable by filtering by subnet’s name
    subnetNoString- Subnet IP address range
    Searchable by filtering with a subnet IP address range
    ex) subnet=10.0.0.0/24
    subnetTypeCodeNoString- Subnet type code
    Searchable by filtering by subnet type code
    Options : PUBLIC | PRIVATE
    usageTypeCodeNoString- Usage type code
    Searchable by filtering by usage type code
    Options: GEN (general) | LOADB (load balancer only) | BM (bare metal only) | NATGW (NAT Gateway only)
    networkAclNoNoString- Network ACL number
    Searchable by filtering by the Network ACL number applied to the subnet
    networkAclNo can be obtained via the getNetworkAclListaction.
    pageNoNoInteger- Page number of paged result
    Paging can be handled using pageNo and pageSize
    pageSizeConditionalInteger- Size of each page to be displayed when paging
    Paging can be handled using pageNo and pageSize
    It must be entered when entering pageNo
    subnetStatusCodeNoString- Subnet status code
    Searchable by filtering by subnet status code
    Options : INIT | CREATING | RUN | TERMTING
    vpcNoNoString- VPC number
    Searchable by filtering by VPC number
    vpcNo can be obtained via the getVpcListaction.
    zoneCodeNoString- Zone code
    Enable to determine the zone in which the subnet list is searched
    zoneCode can be obtained via the getZoneListaction.
    responseFormatTypeNoString- Format type of the response result
    Options : xml | json
    Default : xml

    Responses

    Response bodies

    Examples

    Request examples

    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
    

    Response examples

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

    Was this article helpful?

    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.