getRouteTableSubnetList

Prev Next

VPC環境で利用できます。

ルーティングテーブルに設定された関連 Subnetリストを照会します。

リクエスト

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

メソッド URI
GET | POST /vpc/v2/getRouteTableSubnetList
参考

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional 関連 Subnetリスト照会対象ルーティングテーブルのリージョンコード
  • 照会結果の最初のリージョン(デフォルト)
  • getRegionListを参照
routeTableNo String Required 関連 Subnetリスト照会対象ルーティングテーブルの番号
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location 'https://ncloud.apigw.ntruss.com/vpc/v2/getRouteTableSubnetList
?regionCode=KR
&routeTableNo=***38' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

<getRouteTableSubnetListResponse>
  <requestId>a7ee6059-2060-481f-9a4d-b61a38bf387c</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <subnetList>
    <subnet>
      <subnetNo>***44</subnetNo>
      <vpcNo>***04</vpcNo>
      <zoneCode>KR-1</zoneCode>
      <subnetName>test-***</subnetName>
      <subnet>***.***.1.0/24</subnet>
      <subnetStatus>
        <code>INIT</code>
        <codeName>init</codeName>
      </subnetStatus>
      <subnetType>
        <code>PUBLIC</code>
        <codeName>Public</codeName>
      </subnetType>
    </subnet>
  </subnetList>
</getRouteTableSubnetListResponse>