getRouteTableList

Prev Next

VPC環境で利用できます。

概要

ルートテーブルリストを照会します。

リクエスト

リクエストパラメータ

パラメータ名 必須の有無 タイプ 制約事項 説明
regionCode No String リージョンコード
ルートテーブルリストが照会されるリージョン(Region)を決定できます。
regionCodeはgetRegionListアクションを通じて取得できます。
Default：getRegionList照会結果の最初のリージョンを選択
routeTableNoList.N No List<String> ルートテーブル番号リスト
ルートテーブル番号でフィルタリングして検索できます。
routeTableNoはgetRouteTableListアクションを通じて取得できます。
ex)--routeTableNoList 1234 2345
routeTableName No String ルートテーブル名
ルートテーブル名でフィルタリングして検索できます。
supportedSubnetTypeCode No String サポートするサブネットのタイプコード
ルートテーブルがサポートするサブネットタイプでフィルタリングして検索できます。
Options : PUBLIC (グローバル) | PRIVATE (プライベート)
vpcNo No String VPC番号
VPC番号でフィルタリングして検索できます。
vpcNoはgetVpcListアクションを通じて取得できます。
pageNo No Integer ページングされた結果のページ番号
結果値をpageNo、pageSizeを利用してページング処理できます。
pageSize Conditional Integer ページングする時に表示する各ページのサイズ
結果値をpageNo、pageSizeを利用してページング処理できます。
pageNoを入力する時に必ず入力しなければなりません。
sortedBy No String ソート対象
結果値をルートテーブル名でソートできます。
Options : routeTableName
sortingOrder No String ソート順序
sortedByを利用する時、昇順/降順ソートを設定します。
Options：ASC (昇順) | DESC (降順)
Default : ASC
responseFormatType No String レスポンス結果のフォーマットタイプ
Options : xml | json
Default : xml

レスポンス

レスポンスデータタイプ

  • RouteTableListタイプ
RouteTableList extends CommonResponse
private Integer totalRows;
private List routeTableList = new ArrayList<>();
RouteTable
private String routeTableNo;
private String routeTableName;
private String regionCode;
private String vpcNo;
private CommonCode supportedSubnetType;
private Boolean isDefault;
private CommonCode routeTableStatus;
private String routeTableDescription;

例

リクエスト例

ncloud vpc getRouteTableList --regionCode KR --routeTableNoList 7738 --routeTableName test-table --supportedSubnetTypeCode PUBLIC --vpcNo 3804

レスポンス例

<getRouteTableListResponse>
  <requestId>43623734-4270-463f-a269-a624cdef9154</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <routeTableList>
    <routeTable>
      <routeTableNo>7738</routeTableNo>
      <routeTableName>test-table</routeTableName>
      <regionCode>KR</regionCode>
      <vpcNo>3804</vpcNo>
      <supportedSubnetType>
        <code>PUBLIC</code>
        <codeName>Public</codeName>
      </supportedSubnetType>
      <isDefault>false</isDefault>
      <routeTableStatus>
        <code>RUN</code>
        <codeName>run</codeName>
      </routeTableStatus>
      <routeTableDescription></routeTableDescription>
    </routeTable>
  </routeTableList>
</getRouteTableListResponse>