getSubnetList

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

VPC環境で利用できます。

概要

Subnetリストを照会します。

リクエスト

リクエストパラメータ

パラメータ名	要否	タイプ	説明
regionCode	No	String	- リージョンコード Subnetリストが照会されるリージョン(Region)を決定可能 regionCodeは、getRegionListアクションを通じて取得可能 Default: getRegionList照会結果の最初のリージョンを選択
subnetNoList.N	No	List<String>	- Subnet番号リスト Subnet番号でフィルタリングして検索可能 subnetNoは、getSubnetListアクションを通じて取得可能 ex) subnetNoList.1=1234&subnetNoList.2=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

例

リクエスト例

GET {API_URL}/vpc/v2/getSubnetList
?regionCode=KR
&subnetNoList.1=***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

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

タグ