Search subnet list
    • PDF

    Search subnet list

    • PDF

    Article summary

    Can be used in a VPC environment.

    Description

    Search a list of available subnets.

    Request

    Request URL

    GET https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getSubnetList
    ?softwareProductCode={softwareProductCode}
    &vpcNo={vpcNo} [KR]
    
    GET https://vpcsearchengine.apigw.ntruss.com/api/sgn-v2/cluster/getSubnetList
    ?softwareProductCode={softwareProductCode}
    &vpcNo={vpcNo} [SGN]
    
    GET https://vpcsearchengine.apigw.ntruss.com/api/jpn-v2/cluster/getSubnetList
    ?softwareProductCode={softwareProductCode}
    &vpcNo={vpcNo} [JPN]
    

    Request headers

    HeaderDescription
    x-ncp-apigw-timestampThis is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
    If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.
    x-ncp-apigw-timestamp:{Timestamp}
    x-ncp-iam-access-keyThis is the Access Key ID value issued by the Naver Cloud Platform portal.
    x-ncp-iam-access-key:{Account Access Key}
    x-ncp-apigw-signature-v2This is the signature encrypted Access Key ID value and Secret Key.
    x-ncp-apigw-signature-v2:{API Gateway Signature}
    Content-TypeSpecifies the request body content type as application/json
    Content-Type: application/json

    Request parameters

    ParameterTypeRequired statusDescription
    softwareProductCodeStringYThis is the OS type to use. You can obtain it through the getOsProductList action.
    vpcNoIntegerYThis is the VPC no. to use. You can obtain it with the getVpcList action.

    Request example

    GET https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getSubnetList
    ?softwareProductCode=SW.VELST.OS.LNX64.CNTOS.0708.B050
    &vpcNo=1236
    HOST: vpcsearchengine.apigw.ntruss.com
    Content-Type: application/json
    x-ncp-apigw-signature-v2: zq0FrtlU8JZJi9esTK31bCQUNG3H+jo4CMjMkJDoWSc=
    x-ncp-apigw-timestamp: 1593848345548
    x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw
    
    curl -X GET "https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getSubnetList
    ?softwareProductCode=SW.VELST.OS.LNX64.CNTOS.0708.B050
    &vpcNo=1236" \
    -H "accept: application/json" \
    -H "Content-Type: application/json" \
    -H "x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw" \
    -H "x-ncp-apigw-timestamp: 1601971222179" \
    -H "x-ncp-apigw-signature-v2: zrCelnR48AADdK/uh6Xe3yy468i8KpQoewYHUmeqYh4=" \
    

    Response parameters

    public class GetSubnetListResponseVo {
        ArrayList<SubnetListDetailVo> content;
    }
    
    public class SubnetListDetailVo {
        String subnet;
        String subnetName;
        Integer subnetNo;
        String vpcName;
        Integer vpcNo;
        String zoneName;
        Integer zoneNo;
        String permission;
    }
    

    Field

    Parameter NameTypeDescription
    contentArrayList<SubnetListDetailVo>List of subnets
    subnetStringSubnet IP address range
    subnetNameStringSubnet name
    subnetNoIntegerSubnet number
    vpcNameStringVPC name
    vpcNoIntegerVPC no.
    zoneNameStringzone name
    zoneNoIntegerzone no.
    permissionStringThis is the availability status of a Subaccount account. If it's set to Deny, it means it is not available as you have no getSubnetDetail permissions.

    Response example

    {
      "code": 0,
      "message": "SUCCESS",
      "result": {
        "content": [
          {
            "subnet": "10.0.2.16/28",
            "subnetName": "privatesmall",
            "subnetNo": 22632,
            "vpcName": "test",
            "vpcNo": 36752,
            "zoneName": "KR-1",
            "zoneNo": 2,
            "permission": "Allow"
          },
          {
            "subnet": "10.0.1.0/24",
            "subnetName": "testpri",
            "subnetNo": 22630,
            "vpcName": "test",
            "vpcNo": 36752,
            "zoneName": "KR-1",
            "zoneNo": 2,
            "permission": "Allow"
          }
        ]
      },
      "requestId": "79e63e0c-9cdb-4736-89c6-8a61dab0d687"
    }
    

    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.