MENU
      getVpcList

        getVpcList


        Article summary

        Available in VPC

        View the list of VPCs based on the conditions the user specifies.

        Request

        The following describes the request format for the endpoint. The request format is as follows:

        MethodURI
        GET, POST/getVpcList

        Request headers

        For headers common to all VPC APIs, see VPC common headers.

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        regionCodeStringOptionalRegion code whose network VPC list you want to view
      • First Region of the search result (default)
      • Check through the getRegionList action
      • vpcStatusCodeStringOptionalView the VPC list with the VPC status code
        • INIT | CREATING | RUN | TERMTING
        vpcNameStringOptionalView the VPC list with the VPC name
        vpcNoList.NList<String>OptionalView the VPC list with the VPC number
      • vpcNo can be obtained through getVpcList
      • <E.g.> vpcNoList.1=1234&vpcNoList.2=2345
      • responseFormatTypeStringOptionalResponse result format
        • xml (default) | json

        Request example

        The following is a sample request.

        curl --location 'https://ncloud.apigw.ntruss.com/vpc/v2/getVpcList
        ?regionCode=KR
        &vpcStatusCode=RUN
        &vpcName=test-***
        &vpcNoList.1=***04
        &responseFormatType=xml'
        --header 'x-ncp-apigw-timestamp:: {Timestamp}'
        --header 'x-ncp-iam-access-key: {Access Key}'
        --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
        Curl

        Response

        The following describes the response format.

        Response body

        See VpcList for the response body.

        Response status codes

        For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

        Response example

        The following is a sample response.

        <getVpcListResponse>
          <requestId>9b37ea3e-3ca9-462f-abad-6e23a35fcb76</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <totalRows>1</totalRows>
          <vpcList>
            <vpc>
              <vpcNo>***04</vpcNo>
              <vpcName>test-***</vpcName>
              <ipv4CidrBlock>***.***.0.0/16</ipv4CidrBlock>
              <vpcStatus>
                <code>RUN</code>
                <codeName>run</codeName>
              </vpcStatus>
              <regionCode>KR</regionCode>
              <createDate>2020-07-16T22:23:50+0900</createDate>
            </vpc>
          </vpcList>
        </getVpcListResponse>
        XML

        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.