getVpcDetail
    • PDF

    getVpcDetail

    • PDF

    Article summary

    Available in VPC

    Views detailed information on VPC when creating Notebooks.

    Requests

    Request Parameters

    Parameter nameRequirement statusTypeRestrictionsDescription
    vpcNoYESInteger- vpcNo can be verified through Notebooks’ getVpcList API

    Request headers

    See common guide.

    Request bodies

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

    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/getVpcDetail
    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
    {
      "vpcNo": "8717"
    }
    
    curl -X POST "https://df.apigw.ntruss.com/api/v2/notebooks/getVpcDetail" \
    -H "accept: application/json" \
    -H "Content-Type: application/json" \
    -H "x-ncp-iam-access-key: F5O55GOTR4CqYJqPDnCu" \
    -H "x-ncp-apigw-timestamp: 1684744821022" \
    -H "x-ncp-apigw-signature-v2: Aoi0b3KEWmWfABvAavifPMaz3QRmo6P0EJwLq+PDDF0=" \
    -d "{ \"vpcNo\": 8717}"
    

    Response examples

    • HTTP

      HTTP StatusDescription
      200OK
    • BASH

      {
        "success": true,
        "vpcNo": 8717,
        "vpcName": "test-vpc",
        "regionNo": 1,
        "ipv4Cidr": "172.16.0.0/16",
        "state": "Running",
        "createdAt": "2023-03-21T10:35:43.8+09:00"
      }
      
      

    Errors examples

    • HTTP

      HTTP StatusDescription
      403not allowed to access
    • BASH

      {
        "message": "resource ('string') is not allowed or not exists",
        "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.