getSubnetList

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

VPC環境で利用できます。

概要

Subnetリストを照会します。

リクエスト

リクエストパラメータ

パラメータ名	要否	タイプ	説明
regionCode	No	String	- リージョンコード Subnetリストが照会されるリージョン(Region)を決定できる regionCodeは、getRegionListアクションを通じて取得できる Default: getRegionList照会結果の最初のリージョンを選択
subnetNoList.N	No	List<String>	- Subnet番号リスト Subnet番号でフィルタリングして検索できる subnetNoは、getSubnetListアクションを通じて取得できる ex) --subnetNoList 1234 2345
subnetName	No	String	- Subnet名 Subnet名でフィルタリングして検索できる
subnet	No	String	- Subnet IPアドレスの範囲 Subnet IPアドレスの範囲でフィルタリングして検索できる ex) --subnet 10.0.0.0/24
subnetTypeCode	No	String	- Subnetタイプコード Subnetタイプコードでフィルタリングして検索できる Options: PUBLIC \| PRIVATE
usageTypeCode	No	String	- 用途タイプコード用途タイプコードでフィルタリングして検索できる Options: GEN(一般) \| LOADB(ロードバランサ専用) \| BM(ベアメタル専用) \| NATGW(NAT Gateway専用)
networkAclNo	No	String	- Network ACL番号 Subnetに適用された Network ACL番号でフィルタリングして検索できる networkAclNoは、getNetworkAclListアクションを通じて取得できる
pageNo	No	Integer	- ページングされた結果のページ番号結果値を pageNo、pageSizeを利用してページング処理できる
pageSize	Conditional	Integer	- ページング時に表示する各ページのサイズ結果値を pageNo、pageSizeを利用してページング処理できる pageNo入力時、必ず入力すること
subnetStatusCode	No	String	- Subnetステータスコード Subnetステータスコードでフィルタリングして検索できる Options: INIT \| CREATING \| RUN \| TERMTING
vpcNo	No	String	- VPC番号 VPC番号でフィルタリングして検索できる vpcNoは、getVpcListアクションを通じて取得できる
zoneCode	No	String	- ZONEコード Subnetリストが照会されるゾーン(zone)を決定できる zoneCodeは、getZoneListアクションを通じて取得できる
responseFormatType	No	String	- レスポンス結果のフォーマットタイプ Options: xml \| json Default: xml

レスポンス

レスポンスデータのタイプ

SubnetListのタイプ

SubnetList extends CommonResponse
private Integer totalRows;
private List subnetList = new ArrayList<>();

Subnet
private String subnetNo;
private String vpcNo;
private String zoneCode;
private String subnetName;
private String subnet;
private CommonCode subnetStatus;
private Date createDate;
private CommonCode subnetType;
private CommonCode usageType;
private String networkAclNo;

例

リクエスト例

ncloud vpc getSubnetList --regionCode KR --subnetNoList ***43 --subnetName test-*** --subnet ***.***.1.0 --subnetTypeCode PUBLIC --usageTypeCode GEN --networkAclNo ***31 --subnetStatusCode RUN --vpcNo ***04 --zoneCode KR-1

レスポンス例

<getSubnetListResponse>
  <requestId>4a7ca579-1b43-439b-97f7-c423a37bc3d9</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <subnetList>
    <subnet>
      <subnetNo>***43</subnetNo>
      <vpcNo>***04</vpcNo>
      <zoneCode>KR-1</zoneCode>
      <subnetName>test-***</subnetName>
      <subnet>***.***.1.0/24</subnet>
      <subnetStatus>
        <code>RUN</code>
        <codeName>run</codeName>
      </subnetStatus>
      <createDate>2020-05-04T11:49:52+0900</createDate>
      <subnetType>
        <code>PUBLIC</code>
        <codeName>Public</codeName>
      </subnetType>
      <usageType>
        <code>GEN</code>
        <codeName>General</codeName>
      </usageType>
      <networkAclNo>***31</networkAclNo>
    </subnet>
  </subnetList>
</getSubnetListResponse>

この記事は役に立ちましたか?

What's Next

getSubnetDetail

概要
リクエスト
レスポンス
例

タグ