getVpcPeeringInstanceList

Article summary

Did you find this summary helpful?

Thank you for your feedback

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:

Method	URI
GET, POST	/getVpcPeeringInstanceList

Request headers

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

Request query parameters

The following describes the parameters.

Field	Type	Required	Description
`regionCode`	String	Optional	Region code for which you want to view the list of VPC peering instances First Region of the search result (default) Check through getRegionList
`vpcPeeringInstanceNoList.N`	List<String>	Optional	View with the VPC peering instance `vpcPeeringInstanceNo` can be obtained through getVpcPeeringInstanceList <E.g.> vpcPeeringInstanceNoList.1=1234&vpcPeeringInstanceNoList.2=2345
`sourceVpcName`	String	Optional	View with the VPC name
`targetVpcName`	String	Optional	View with the VPC name that accepted peering
`vpcPeeringName`	String	Optional	View with the VPC peering name
`vpcPeeringInstanceStatusCode`	String	Optional	View with the status code of the VPC peering instance `INIT` \| `RUN` \| `TERMTING` `INIT`: Pending acceptance `RUN`: Running `TERMTING`: Terminating
`pageNo`	Integer	Optional	Page number of the paged results Page the result values using `pageNo` and `pageSize`
	`pageSize`	Integer	Conditional
`sortedBy`	String	Optional	Sort search results by `vpcPeeringName` \| `sourceVpcName` \| `targetVpcName` `vpcPeeringName`: VPC peering name `sourceVpcName`: requested VPC name `targetVpcName`: accepted VPC name
`sortingOrder`	String	Optional	Set ascending or descending sorting when using `sortedBy` `ASC` (default) \| `DESC` `ASC`: ascending `DESC`: descending
`responseFormatType`	String	Optional	Response 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}'

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>

Was this article helpful?

What's Next

getVpcPeeringInstanceDetail

Table of contents

Request
Response