getVpcPeeringInstanceList
- Print
- PDF
getVpcPeeringInstanceList
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Can be used in a VPC environment.
Overview
Query the list of VPC Peering instances.
Request
Request parameter
| Parameter Name | Required Status | Type | Restrictions | Description |
|---|---|---|---|---|
| regionCode | No | String | Region Code You can decide the region where the list of VPC Peering instances will be queried. The regionCode can be obtained through the getRegionList action. Default: Select the first region of the getRegionList query results. | |
| vpcPeeringInstanceNoList.N | No | List<String> | List of the VPC Peering instance numbers You can search by filtering with the VPC Peering number. vpcPeeringInstanceNo can be obtained through the getVpcPeeringInstanceList action. ex) --vpcPeeringInstanceNoList 1234 2345 | |
| sourceVpcName | No | String | The requesting VPC name You can search by filtering with the name of the VPC requesting Peering. | |
| targetVpcName | No | String | The name of the VPC that accepted You can search by filtering with the name of the VPC that accepts Peering. | |
| vpcPeeringName | No | String | The name of VPC Peering You can search by filtering with a VPC Peering name. | |
| vpcPeeringInstanceStatusCode | No | String | The status code of VPC Peering instance You can search by filtering with the status code of the VPC Peering instance. Options : INIT | RUN | TERMTING | |
| pageNo | No | Integer | The page number of the paged results The results can shown as pages using pageNo and pageSize. | |
| pageSize | Conditional | Integer | The size of each page to be displayed at the time of paging The results can shown as pages using pageNo and pageSize. Enter it when entering pageNo. | |
| sortedBy | No | String | Sorting target You can sort the results by VPC Peering name, requesting VPC name, and accepting VPC name. Options : vpcPeeringName | sourceVpcName | targetVpcName | |
| sortingOrder | No | String | Sorting order When using sortedBy, set sorting in ascending /descending order. Options: ASC (ascending order) | DESC (descending order) Default : ASC | |
| responseFormatType | No | String | Format type for the response result Options : xml | json Default : xml |
Response
Response data type
- VpcPeeringInstanceList type
| VpcPeeringInstanceList extends CommonResponse |
|---|
| private Integer totalRows; |
| private List |
| VpcPeeringInstance |
|---|
| private String vpcPeeringInstanceNo; |
| private String vpcPeeringName; |
| private String regionCode; |
| private Date createDate; |
| private Date lastModifyDate; |
| private CommonCode vpcPeeringInstanceStatus; |
| private String vpcPeeringInstanceStatusName; |
| private CommonCode vpcPeeringInstanceOperation; |
| private String sourceVpcNo; |
| private String sourceVpcName; |
| private String sourceVpcIpv4CidrBlock; |
| private String sourceVpcLoginId; |
| private String targetVpcNo; |
| private String targetVpcName; |
| private String targetVpcIpv4CidrBlock; |
| private String targetVpcLoginId; |
| private String vpcPeeringDescription; |
| private Boolean hasReverseVpcPeering; |
| private Boolean isBetweenAccounts; |
| private String reverseVpcPeeringInstanceNo; |
Example
Request example
ncloud vpc getVpcPeeringInstanceList --regionCode KR --vpcPeeringInstanceNoList ***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?