getSubnetList

VPC環境で利用できます。

ユーザーが指定した条件に基づいて Subnetリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET \| POST	/vpc/v2/getSubnetList

参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

VPC APIで共通して使用されるヘッダの詳細は、VPCのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	Subnetリスト照会対象のリージョンコード照会結果の最初のリージョン(デフォルト) getRegionListを参照
`subnetNoList.N`	List[String]	Optional	Subnet番号でリストを照会 `subnetNo`はgetSubnetListを参照 <例>subnetNoList.1=1234&subnetNoList.2=2345
`subnetName`	String	Optional	Subnet名でリストを照会
`subnet`	String	Optional	Subnet IPアドレスの範囲でリストを照会 <例>`subnet`=10.0.0.0/24
`subnetTypeCode`	String	Optional	Subnetタイプコードでリストを照会 `PUBLIC` \| `PRIVATE`
`usageTypeCode`	String	Optional	Subnet用途タイプコードで Subnetリストを照会 `GEN`\| `LOADB` \| `BM` \| `NATGW` `GEN`: 一般 `LOADB`: ロードバランサ専用 `BM`: ベアメタル専用 `NATGW`: NAT Gateway専用
`networkAclNo`	String	Optional	Subnetに適用された Network ACL番号で Subnetリストを照会 `networkAclNo`はgetNetworkAclListを参照
`pageNo`	Integer	Optional	ページングされた結果のページ番号 `pageNo`、`pageSize`を利用して結果値をページング処理
`pageSize`	Integer	Conditional	ページング時に表示する各ページのサイズ `pageNo`入力時、必須 `pageNo`、`pageSize`を利用して結果値をページング処理
`subnetStatusCode`	String	Optional	Subnetの状態コードで Subnetリストを照会 `INIT` \| `CREATING` \| `RUN` \| `TERMTING`
`vpcNo`	String	Optional	VPC番号で Subnetリストを照会 getVpcListを参照
`zoneCode`	String	Optional	ゾーンコードで Subnetリストを照会 getZoneListを参照
`responseFormatType`	String	Optional	レスポンス結果の形式 `xml`(デフォルト) \| `json`

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location 'https://ncloud.apigw.ntruss.com/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' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの詳細は、SubnetListをご参照ください。

レスポンスステータスコード

VPC APIで共通して使用されるレスポンスステータスコードの詳細は、VPCのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

<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>