getVpcList

Prev Next

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