getVpcDetail

Prev Next

Can be used in a VPC environment.

Overview

Query the VPC details using the VPC number.

Request

Request parameter

Parameter Name Required Status Type Restrictions Description
regionCode No String Region Code
You can decide the region where the VPC details will be queried.
The regionCode can be obtained through the getRegionList action.
Default: Select the first region of the getRegionList query results.
vpcNo Yes String The number of the VPC to be queried
vpcNo can be obtained through the getVpcList action.
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 getVpcDetail --regionCode KR --vpcNo ***04

Response example

<getVpcDetailResponse>
  <requestId>13f37a8e-780f-4f32-9115-503a2026cf6d</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>
</getVpcDetailResponse>