getVpcPeeringInstanceList

개요

VPC Peering 인스턴스 리스트를 조회합니다.

요청

요청 파라미터

파라미터명 필수 여부 타입 제약 사항 설명
regionCode No String 리전 코드
VPC Peering 인스턴스 리스트가 조회될 리전(Region)을 결정할 수 있습니다.
regionCode는 getRegionList 액션을 통해서 획득할 수 있습니다.
Default : getRegionList 조회 결과의 첫 번째 리전을 선택
vpcPeeringInstanceNoList.N No List<String> VPC Peering 인스턴스 번호 리스트
VPC Peering 인스턴스 번호로 필터링하여 검색할 수 있습니다.
vpcPeeringInstanceNo는 getVpcPeeringInstanceList 액션을 통해서 획득할 수 있습니다.
ex) vpcPeeringInstanceNoList.1=1234&vpcPeeringInstanceNoList.2=2345
sourceVpcName No String 요청 VPC 이름
Peering을 요청한 VPC의 이름으로 필터링하여 검색할 수 있습니다.
targetVpcName No String 수락 VPC 이름
Peering을 수락한 VPC의 이름으로 필터링하여 검색할 수 있습니다.
vpcPeeringName No String VPC Peering 이름
VPC Peering 이름으로 필터링하여 검색할 수 있습니다.
vpcPeeringInstanceStatusCode No String VPC Peering 인스턴스 상태 코드
VPC Peering 인스턴스의 상태 코드로 필터링하여 검색할 수 있습니다.
Options : INIT | RUN | TERMTING
pageNo No Integer 페이징된 결과의 페이지 번호
결과값을 pageNo, pageSize를 이용하여 페이징 처리를 할 수 있습니다.
pageSize Conditional Integer 페이징 시 보여줄 각 페이지 사이즈
결과값을 pageNo, pageSize를 이용하여 페이징 처리를 할 수 있습니다.
pageNo 입력시 반드시 입력합니다.
sortedBy No String 정렬 대상
결과값을 VPC Peering 이름, 요청 VPC 이름, 수락 VPC 이름으로 정렬할 수 있습니다.
Options : vpcPeeringName | sourceVpcName | targetVpcName
sortingOrder No String 정렬 순서
sortedBy 이용시 오름차순/내림차순 정렬을 설정합니다.
Options : ASC (오름차순) | DESC (내림차순)
Default : ASC
responseFormatType No String 응답 결과의 포맷 타입
Options : xml | json
Default : xml

응답

응답 바디

예시

요청 예시

GET {API_URL}/vpc/v2/getVpcPeeringInstanceList
?regionCode=KR
&vpcPeeringInstanceNoList.1=***6212
&sourceVpcName=test-***
&targetVpcName=test-***
&vpcPeeringName=test-peering
&vpcPeeringInstanceStatusCode=RUN

응답 예시

<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>운영중</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>