getSubnetDetail
    • PDF

    getSubnetDetail

    • PDF

    Article summary

    Available in VPC

    Views detailed information on Subnet when creating Notebooks.

    Requests

    Request Parameters

    Parameter nameRequirement statusTypeRestrictionsDescription
    vpcNoYESInteger- vpcNo can be verified through Notebooks’ getVpcList API
    subnetNoYESIntegerOnly the Public Subnet of Korea (KR2) Region (Zone) is available- subnetNo can be verified through Notebooks’ getSubnetList API

    Request headers

    See common guide.

    Request bodies

    • JSON
        {
            "vpcNo": 0,
            "subnetNo": 0
        }
      
    • XML
        <?xml version="1.0" encoding="UTF-8"?>
        <GetSubnetDetailRequest>
            <vpcNo>0</vpcNo>
            <subnetNo>0</subnetNo>
        </GetSubnetDetailRequest>
      

    Errors

    HTTP StatusDescription
    400invalid request parameters
    403not allowed to access
    404no such element
    500unexpected error

    Examples

    Request Examples

    POST https://df.apigw.ntruss.com/api/v2/notebooks/getSubnetDetail
    HOST: df.apigw.ntruss.com
    Content-Type: application/json
    x-ncp-apigw-signature-v2: Azm1WBMWDgEONUCUbsVkB4tRIpc053uOHU8bitbQRtU=
    x-ncp-apigw-timestamp: 1658898041497
    x-ncp-iam-access-key: F5O55GOTR4CqYJqPDnCu
    { 
        "subnetNo":1394, \
        "vpcNo": 8717
     }
    
    curl -X POST "https://df.apigw.ntruss.com/api/v2/notebooks/getSubnetDetail" \
    -H "accept: application/json" \
    -H "Content-Type: application/json" \
    -H "x-ncp-iam-access-key: F5O55GOTR4CqYJqPDnCu" \
    -H "x-ncp-apigw-timestamp: 1684748047387" \
    -H "x-ncp-apigw-signature-v2: Bn0+uh2bqUAwtiOCs9YZOzAjy7+DwT78HUvVjzyfm+s=" \
    -d "{ \"subnetNo\":1394, \"vpcNo\": 8717}"
    

    Response examples

    • HTTP

      HTTP StatusDescription
      200OK
    • BASH

      {
          "success": true,
          "vpcNo": 8717,
          "vpcName": "test-vpc",
          "zoneNo": 3,
          "zoneName": "KR-2",
          "subnetNo": 13594,
          "subnetName": "prisub-kr",
          "subnet": "172.16.3.0/24",
          "createdAt": "2023-05-16T15:00:48.066+09:00",
          "state": "RUN",
          "isPublic": true
      }
      
      

    Errors examples

    • HTTP

      HTTP StatusDescription
      400invalid request parameters
    • BASH

        {
            "message": "invalid request parameter (constraint violation Not available, user subnet number '1394')",
            "success": false
        }
      

    Was this article helpful?

    What's Next
    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.