getVpcPeeringInstanceList
    • PDF

    getVpcPeeringInstanceList

    • PDF

    기사 요약

    VPC 환경에서 이용 가능합니다.

    지정한 조건에 따라 VPC Peering 인스턴스 목록을 조회합니다.

    요청

    요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

    메서드URI
    GET, POST/getVpcPeeringInstanceList

    요청 헤더

    VPC API에서 공통으로 사용하는 헤더에 대한 자세한 내용은 VPC 공통 헤더를 참조해 주십시오.

    요청 쿼리 파라미터

    파라미터에 대한 설명은 다음과 같습니다.

    필드타입필수 여부설명
    regionCodeStringOptionalVPC Peering 인스턴스 목록을 조회하려는 리전 코드
  • 조회 결과의 첫 번째 리전(기본값)
  • getRegionList를 통해 확인
  • vpcPeeringInstanceNoList.NList<String>OptionalVPC Peering 인스턴스 번호로 조회
  • vpcPeeringInstanceNogetVpcPeeringInstanceList를 통해 확인
  • <예시>vpcPeeringInstanceNoList.1=1234&vpcPeeringInstanceNoList.2=2345
  • sourceVpcNameStringOptionalPeering을 요청한 VPC 이름으로 조회
    targetVpcNameStringOptionalPeering을 수락한 VPC 이름으로 조회
    vpcPeeringNameStringOptionalVPC Peering 이름으로 조회
    vpcPeeringInstanceStatusCodeStringOptionalVPC Peering 인스턴스의 상태 코드로 조회
    • INIT | RUN | TERMTING
      • INIT: 수락 대기 중
      • RUN: 운영 중
      • TERMTING: 종료 중
    pageNoIntegerOptional페이징된 결과의 페이지 번호
    • pageNo, pageSize를 이용하여 결과값을 페이징 처리
    pageSizeIntegerConditional한 페이지에 보여줄 결과 개수
    • pageNo 입력 시 필수
    • pageNo, pageSize를 이용하여 결과값을 페이징 처리
    sortedByStringOptional조회 결과값 정렬 기준
    • vpcPeeringName | sourceVpcName | targetVpcName
      • vpcPeeringName: VPC Peering 이름
      • sourceVpcName: 요청 VPC 이름
      • targetVpcName: 수락 VPC 이름
    sortingOrderStringOptionalsortedBy 이용시 오름차순 또는 내림차순 정렬 설정
    • ASC (기본값) | DESC
      • ASC: 오름차순
      • DESC: 내림차순
    responseFormatTypeStringOptional응답 결과의 형식
    • xml (기본값) | json

    요청 예시

    요청 예시는 다음과 같습니다.

    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}'
    

    응답

    응답 형식을 설명합니다.

    응답 바디

    응답 바디는 VpcPeeringInstanceList를 참조해 주십시오.

    응답 상태 코드

    네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 Ncloud API 응답 상태 코드를 참조해 주십시오.

    응답 예시

    응답 예시는 다음과 같습니다.

    <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>
    

    이 문서가 도움이 되었습니까?

    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.