getVpcList

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

개요

VPC 리스트를 조회합니다.

요청

요청 파라미터

파라미터명 필수 여부 타입 제약 사항 설명
regionCode No String - 리전 코드
VPC 리스트가 조회될 리전(Region) 결정 가능
regionCode는 getRegionList 액션을 통해 획득 가능
Default : getRegionList 조회 결과의 첫 번째 리전을 선택
vpcStatusCode No String - VPC 상태 코드
VPC 상태 코드로 필터링하여 검색 가능
Options : INIT | CREATING | RUN | TERMTING
vpcName No String - VPC 이름
VPC 이름으로 필터링하여 검색 가능
vpcNoList.N No List<String> - VPC 번호 리스트
VPC 번호로 필터링하여 검색 가능
vpcNo는 getVpcList 액션을 통해 획득 가능
ex) --vpcNoList 1234 2345
responseFormatType No String - 응답 결과의 포맷 타입
Options : xml | json
Default : xml

응답

응답 데이터 타입

  • VpcList 타입
VpcList extends CommonResponse
private Integer totalRows;
private List vpcList = new ArrayList<>();
Vpc
private String vpcNo;
private String vpcName;
private String ipv4CidrBlock;
private CommonCode vpcStatus;
private String regionCode;
private Date createDate;

예시

요청 예시

ncloud vpc getVpcList --regionCode FKR --vpcStatusCode RUN --vpcName test-*** --vpcNoList ***04

응답 예시

<getVpcListResponse>
  <requestId>9b37ea3e-3ca9-462f-abad-6e23a35fcb76</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <vpcList>
    <vpc>
      <vpcNo>***04</vpcNo>
      <vpcName>test-***</vpcName>
      <ipv4CidrBlock>***.***.0.0/16</ipv4CidrBlock>
      <vpcStatus>
        <code>RUN</code>
        <codeName>run</codeName>
      </vpcStatus>
      <regionCode>FKR</regionCode>
      <createDate>2020-07-16T22:23:50+0900</createDate>
    </vpc>
  </vpcList>
</getVpcListResponse>