MENU
      getVpcPeeringInstanceList

        getVpcPeeringInstanceList


        Article summary

        Available in VPC

        View the list of VPC peering instances based on the specified conditions.

        Request

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

        MethodURI
        GET, POST/getVpcPeeringInstanceList

        Request headers

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

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        regionCodeStringOptionalRegion code for which you want to view the list of VPC peering instances
      • First Region of the search result (default)
      • Check through getRegionList
      • vpcPeeringInstanceNoList.NList<String>OptionalView with the VPC peering instance
      • vpcPeeringInstanceNo can be obtained through getVpcPeeringInstanceList
      • <E.g.> vpcPeeringInstanceNoList.1=1234&vpcPeeringInstanceNoList.2=2345
      • sourceVpcNameStringOptionalView with the VPC name
        targetVpcNameStringOptionalView with the VPC name that accepted peering
        vpcPeeringNameStringOptionalView with the VPC peering name
        vpcPeeringInstanceStatusCodeStringOptionalView with the status code of the VPC peering instance
        • INIT | RUN | TERMTING
          • INIT: Pending acceptance
          • RUN: Running
          • TERMTING: Terminating
        pageNoIntegerOptionalPage number of the paged results
        • Page the result values using pageNo and pageSize
        pageSizeIntegerConditional
        sortedByStringOptionalSort search results by
        • vpcPeeringName | sourceVpcName | targetVpcName
          • vpcPeeringName: VPC peering name
          • sourceVpcName: requested VPC name
          • targetVpcName: accepted VPC name
        sortingOrderStringOptionalSet ascending or descending sorting when using sortedBy
        • ASC (default) | DESC
          • ASC: ascending
          • DESC: descending
        responseFormatTypeStringOptionalResponse result format
        • xml (default) | json

        Request example

        The following is a sample request.

        curl --location 'https://ncloud.apigw.ntruss.com/vpc/v2/getVpcPeeringInstanceList
        ?regionCode=KR
        &vpcPeeringInstanceNoList.1=***6212
        &sourceVpcName=test-***
        &targetVpcName=test-***
        &vpcPeeringName=test-peering
        &vpcPeeringInstanceStatusCode=RUN'
        --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 VpcPeeringInstanceList 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.

        <getVpcPeeringInstanceListResponse>
          <requestId>d0d25721-3f73-4b76-baf8-63232d5a8351</requestId>
          <returnCode>0</returnCode>
          <returnMessage>success</returnMessage>
          <totalRows>1</totalRows>
          <vpcPeeringInstanceList>
            <vpcPeeringInstance>
              <vpcPeeringInstanceNo>***6212</vpcPeeringInstanceNo>
              <vpcPeeringName>test-***</vpcPeeringName>
              <regionCode>KR</regionCode>
              <createDate>2020-08-05T20:53:16+0900</createDate>
              <lastModifyDate>2020-08-05T20:53:16+0900</lastModifyDate>
              <vpcPeeringInstanceStatus>
                <code>RUN</code>
                <codeName>run</codeName>
              </vpcPeeringInstanceStatus>
              <vpcPeeringInstanceStatusName>Running</vpcPeeringInstanceStatusName>
              <vpcPeeringInstanceOperation>
                <code>NULL</code>
                <codeName>NULL OP</codeName>
              </vpcPeeringInstanceOperation>
              <sourceVpcNo>***05</sourceVpcNo>
              <sourceVpcName>test-***</sourceVpcName>
              <sourceVpcIpv4CidrBlock>***.**1.0.0/16</sourceVpcIpv4CidrBlock>
              <sourceVpcLoginId>test-***@naver.com</sourceVpcLoginId>
              <targetVpcNo>***06</targetVpcNo>
              <targetVpcName>test-***</targetVpcName>
              <targetVpcIpv4CidrBlock>***.**2.0.0/16</targetVpcIpv4CidrBlock>
              <targetVpcLoginId>test-***@naver.com</targetVpcLoginId>
              <vpcPeeringDescription></vpcPeeringDescription>
              <hasReverseVpcPeering>false</hasReverseVpcPeering>
              <isBetweenAccounts>false</isBetweenAccounts>
              <reverseVpcPeeringInstanceNo></reverseVpcPeeringInstanceNo>
            </vpcPeeringInstance>
          </vpcPeeringInstanceList>
        </getVpcPeeringInstanceListResponse>
        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.