getVpcList

Prev Next

Can be used in a VPC environment.

Overview

Query the VPC list.

Request

Request parameter

Parameter Name Required Status Type Restrictions Description
regionCode No String Region Code
You can decide the region where the VPC list will be queried.
The regionCode can be obtained through the getRegionList action.
Default: Select the first region of the getRegionList query results.
vpcStatusCode No String VPC status code
You can search by filtering with the VPC status code.
Options : INIT | CREATING | RUN | TERMTING
vpcName No String VPC name
You can search by filtering with an VPC name.
vpcNoList.N No List<String> List of VPC numbers
You can search by filtering with the VPC number.
vpcNo can be obtained through the getVpcList action.
ex) --vpcNoList 1234 2345
responseFormatType No String Format type for the response result
Options : xml | json
Default : xml

Response

Response data type

  • VpcList type
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;

Example

Request example

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

Response example

<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>KR</regionCode>
      <createDate>2020-07-16T22:23:50+0900</createDate>
    </vpc>
  </vpcList>
</getVpcListResponse>