getVpcPeeringInstanceList
- Print
- PDF
getVpcPeeringInstanceList
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Can be used in a VPC environment.
Overview
This searches the VPC Peering instance list.
Request
Request parameters
| Parameter name | Required | Type | Restrictions | Description |
|---|---|---|---|---|
| regionCode | No | String | Region code You can decide the region in which the list of VPC Peering instances will be queried. regionCode can be obtained through the getRegionList action. Default: Select the first region of the getRegionList search results | |
| vpcPeeringInstanceNoList.N | No | List<String> | List of VPC Peering instance numbers You can search by filtering with a VPC Peering instance number. vpcPeeringInstanceNo can be obtained through the getVpcPeeringInstanceList action. ex) vpcPeeringInstanceNoList.1=1234&vpcPeeringInstanceNoList.2=2345 | |
| sourceVpcName | No | String | Requested VPC name You can search by filtering with the name of the VPC that requests Peering. | |
| targetVpcName | No | String | Accepted VPC name You can search by filtering with the name of the VPC that accepts Peering. | |
| vpcPeeringName | No | String | VPC Peering name You can search by filtering with a VPC Peering name. | |
| vpcPeeringInstanceStatusCode | No | String | VPC Peering instance status code You can search by filtering with a VPC Peering instance status code. Options : INIT | RUN | TERMTING | |
| pageNo | No | Integer | Page number of the paged results The results can be paged using pageNo and pageSize. | |
| pageSize | Conditional | Integer | Each page size to be displayed when paging The results can be paged using pageNo and pageSize. It must be entered when entering pageNo. | |
| sortedBy | No | String | Sort target The results can be sorted by VPC Peering name, requested VPC name, and accepted VPC name. Options : vpcPeeringName | sourceVpcName | targetVpcName | |
| sortingOrder | No | String | Sorting order When using sortedBy, sort in ascending/descending order. Options: ASC (ascending order) | DESC (descending order) Default : ASC | |
| responseFormatType | No | String | Format type of the response results Options : xml | json Default : xml |
Response
Response body
Example
Request Example
GET {API_URL}/vpc/v2/getVpcPeeringInstanceList
?regionCode=KR
&vpcPeeringInstanceNoList.1=***6212
&sourceVpcName=test-***
&targetVpcName=test-***
&vpcPeeringName=test-peering
&vpcPeeringInstanceStatusCode=RUN
Response Example
<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>
<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?