本文へジャンプします。

ニフクラ ユーザーガイド

NiftyDescribeNatTables

処理概要

指定したNATテーブルの情報を取得します。
NATテーブルを指定するためには、NATテーブルIDが必要です。NATテーブルを指定しない場合は、取得可能なすべてのNATテーブル情報を取得します。

絞り込み条件の項目の値「Filter.n.Value.m」を指定する際、ワイルドカード文字(曖昧検索)指定可能です。
「∗」は0個以上任意文字、 「?」は1個任意文字、「¥」はエスケープ変換文字(「¥∗niftycloud¥?¥¥」は「∗niftycloud?¥」を検索)となります。

曖昧検索が指定可能な絞り込み条件の項目名は、下記の通りです。

  • nat-rule.description
  • nat-rule.destination.address
  • nat-rule.source.address
  • nat-rule.translation.address
  • nt-rule.outbound-interface.network-name
  • nat-rule.inbound-interface.network-name

指定するパラメーター

パラメーター 説明 必須
NatTableId.n string NATテーブルID
Filter.n.Name string 絞り込み条件の項目名
値: association.association-id (NATテーブル適用ID) | association.nat-table-id (NATテーブル適用情報のNATテーブルID) | association.router-id (NATテーブル適用情報のルーターユニークID) | nat-table-id (NATテーブルID) | nat-rule.nat-type (NATタイプ) | nat-rule.rule-number (ルール番号) | nat-rule.description (NATルールのメモ) | nat-rule.protocol (プロトコル) | nat-rule.outbound-interface.network-id (NATトラフィックのアウトバウンドインターフェイスのネットワークID) | nat-rule.outbound-interface.network-name (NATトラフィックのアウトバウンドインターフェイスのネットワーク名) | nat-rule.inbound-interface.network-id (NATトラフィックのインバウンドインターフェイスのネットワークID) | nat-rule.inbound-interface.network-name (NATトラフィックのインバウンドインターフェイスのネットワーク名) | nat-rule.destination.address (送信先アドレス) | nat-rule.destination.port (送信先ポート) | nat-rule.source.address (送信元アドレス) | nat-rule.source.port (送信元ポート) | nat-rule.translation.address (変換アドレス) | nat-rule.translation.port (変換ポート)
Filter.n.Value.m string 絞り込み条件の値

応答フィールド

フィールド (項目) 説明
NiftyDescribeNatTablesResponse - NiftyDescribeNatTablesレスポンス
Ancestor: なし
Children: requestId | natTableSet
requestId string リクエスト識別子
Ancestor: NiftyDescribeNatTablesResponse
Children: なし
natTableSet - NATテーブル情報セット
Ancestor: NiftyDescribeNatTablesResponse
Children: item
item - NATテーブル情報
Ancestor: natTableSet
Children: natTableId | natRuleSet | associationSet | tagSet
natTableId string NATテーブルID
Ancestor: item
Children: なし
natRuleSet - NATルールリスト情報セット
Ancestor: item
Children: item
item - NATルールリスト情報
Ancestor: natRuleSet
Children: natType | ruleNumber | description | protocol | outboundInterface | inboundInterface | destination | source | translation
natType string NATタイプ
Ancestor: item
Children: なし
ruleNumber string ルール番号
Ancestor: item
Children: なし
description string NATルールのメモ(CDATA付)
Ancestor: item
Children: なし
protocol string プロトコル
Ancestor: item
Children: なし
outboundInterface - NATトラフィックのアウトバウンドインターフェイス(snatの場合のみ)
Ancestor: item
Children: networkId | networkName
networkId string ネットワークID
Ancestor: outboundInterface
Children: なし
networkName string ネットワーク名
Ancestor: outboundInterface
Children: なし
inboundInterface - NATトラフィックのインバウンドインターフェイス(dnatの場合のみ)
Ancestor: item
Children: networkId | networkName
networkId string ネットワークID
Ancestor: inboundInterface
Children: なし
networkName string ネットワーク名
Ancestor: inboundInterface
Children: なし
destination - 送信先情報
Ancestor: item
Children: port
port integer 送信先ポート
Ancestor: destination
Children: なし
source - 送信元情報
Ancestor: item
Children: address | port
address string 送信元アドレス
Ancestor: source
Children: なし
port integer 送信元ポート
Ancestor: source
Children: なし
translation - 変換情報
Ancestor: item
Children: address | port
address string 送信元アドレス
Ancestor: translation
Children: なし
port integer 送信元ポート
Ancestor: translation
Children: なし
associationSet - NATテーブル適用情報セット
Ancestor: item
Children: item
item - NATテーブル適用情報
Ancestor: associationSet
Children: associationId | natTableId | routerId | routerName
associationId string NATテーブル適用ID
Ancestor: item
Children: なし
natTableId string NATテーブルID
Ancestor: item
Children: なし
routerId string ルーターユニークID
Ancestor: item
Children: なし
routerName string ルーター名
Ancestor: item
Children: なし
tagSet - ※空を返却
リソースに設定されているタグ情報セット
Ancestor: item
Children: item
item - リソースに設定されているタグ情報
Ancestor: tagSet
Children: key | value
key string 設定されているタグのキー
Ancestor: item
Children: なし
value string 設定されているタグの値
Ancestor: item
Children: なし

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=NiftyDescribeNatTables
  &NatTableId.1=nat-8db04f81
  &Filter.1.Name=nat-rule.protocol
  &Filter.1.Value.1=tcp
  &CommonParams

  

応答サンプル

    <NiftyDescribeNatTablesResponse xmlns="https:://computing.api.nifcloud.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <natTableSet>
    <item>
      <natTableId>nat-8db04f81</natTableId>
      <natRuleSet>
        <item>
          <natType>snat</natType>
          <ruleNumber>1</ruleNumber>
          <description><![CDATA[memo]]></description>
          <protocol>TCP</protocol>
          <outboundInterface>
            <networkId>net-8db04f81</networkId>
            <networkName>network001</networkName>
          </outboundInterface>
          <source>
            <address>172.16.10.12</address>
            <port>8080</port>
          </source>
          <translation>
            <port>8080</port>
          </translation>
        </item>
        <item>
          <natType>dnat</natType>
          <ruleNumber>1</ruleNumber>
          <description><![CDATA[memo]]></description>
          <protocol>TCP</protocol>
          <inboundInterface>
            <networkId>net-8db04f81</networkId>
            <networkName>network001</networkName>
          </inboundInterface>
          <destination>
            <port>8080</port>
          </destination>
          <translation>
            <address>192.168.1.1</address>
            <port>8080</port>
          </translation>
        </item>  
      </natRuleSet>
      <associationSet>
        <item>
          <associationId>natassoc-12ad487b</associationId>
          <natTableId>nat-8db04f81</natTableId>
          <routerId>rt-13ad487a</routerId>
          <routerName>router1</routerName>
        </item>
      </associationSet>
      <tagSet/>
    </item>
  </natTableSet>
</NiftyDescribeNatTablesResponse>

  

ニフクラ サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ

推奨画面サイズ 1024×768 以上