本文へジャンプします。

ニフクラ APIリファレンス

NiftyDescribeNatTables

処理概要

指定したNATテーブルの情報を取得します。
NATテーブルを指定するためには、NATテーブルIDが必要です。管理外のNATテーブルを指定したなど、無効なNATテーブルを指定した場合は、エラーが返されます。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 NATテーブルID
Type : String
   
Filter.n.Name 絞り込み条件の項目名
Type : 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 絞り込み条件の値
Type : String
   

応答フィールド

フィールド(項目) 説明 サンプル値
NiftyDescribeNatTablesResponse NiftyDescribeNatTablesレスポンス
Type : NiftyDescribeNatTablesResponseType∗
Ancestor : なし
Children : requestId, natTableSet
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : NiftyDescribeNatTablesResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
natTableSet NATテーブル情報セット
Type : NatTableSetType
Ancestor : NiftyDescribeNatTablesResponse
Children : item
 
item NATテーブル情報
Type : NatTableSetType
Ancestor : natTableSet
Children : natTableId,natRuleSet,associationSet,tagSet
 
natTableId NATテーブルID
Type : xsd:string
Ancestor : item
Children : なし
 
natRuleSet NATルールリスト情報セット
Type : NatRuleSetType
Ancestor : item
Children : item
 
item NATルールリスト情報
Type : NatRuleType
Ancestor : natRuleSet
Children : natType,ruleNumber,description,protocol,outboundInterface,inboundInterface,destination,source,translation
 
natType NATタイプ
Type : xsd:string
値: snat | dnat
Ancestor : item
Children : なし
 
ruleNumber ルール番号
Type : xsd:string
Ancestor : item
Children : なし
 
description NATルールのメモ
Type : xsd:string
Ancestor : item
Children : なし
 
protocol プロトコル
Type : xsd:string
値: ALL | TCP | UDP | TCP_UDP | ICMP
Ancestor : item
Children : なし
 
outboundInterface NATトラフィックのアウトバウンドインターフェイス(snatの場合のみ)
Type : NetworkInterfaceType
Ancestor : item
Children : networkId,networkName
 
networkId ネットワークID
Type : xsd:string
Ancestor : outboundInterface Children : なし
 
networkName ネットワーク名
Type : xsd:string
Ancestor : outboundInterface
Children : なし
 
inboundInterface NATトラフィックのインバウンドインターフェイス(dnatの場合のみ)
Type : NetworkInterfaceType
Ancestor : item
Children : networkId,networkName
 
networkId ネットワークID
Type : xsd:string
値:active | blackhole
Ancestor : inboundInterface
Children : なし
 
networkName ネットワーク名
Type : xsd:string
Ancestor : inboundInterface
Children : なし
 
destination 送信先情報
Type : DestinationType
Ancestor : item
Children : port
 
port 送信先ポート
Type : xsd: integer
Ancestor : destination
Children : なし
 
source 送信元情報
Type : SourceType
Ancestor : item
Children : address,port
 
address 送信元アドレス
Type : xsd:string
Ancestor : source
Children : なし
 
port 送信元ポート
Type : xsd: integer
Ancestor : source
Children : なし
 
translation 変換情報
Type : TranslationType
Ancestor : item
Children : address,port
 
address 送信元アドレス
Type : xsd:string
Ancestor : translation
Children : なし
 
port 送信元ポート
Type : xsd: integer
Ancestor : translation
Children : なし
 
associationSet NATテーブル適用情報セット
Type : NatTableAssociationSetType
Ancestor : item
Children : item
 
item NATテーブル適用情報
Type :NatTableAssociationType
Ancestor : associationSet
Children : associationId,natTableId,routerId,routerName
 
associationId NATテーブル適用ID
Type : xsd:string
Ancestor : item
Children : なし
 
natTableId NATテーブルID
Type : xsd:string
Ancestor : item
Children : なし
 
routerId ルーターユニークID
Type : xsd:string
Ancestor : item
Children : なし
 
routerName ルーター名
Type : xsd:string
Ancestor : item
Children : なし
 
tagSet リソースに設定されているタグ情報セット
Type : ResourceTagSetType
Ancestor : item
Children : item
 
item リソースに設定されているタグ情報
Type : ResourceTagSetItemType
Ancestor : tagSet
Children : key,value
 
key 設定されているタグのキー
Type : xsd:string
Ancestor : item
Children : なし
 
value 設定されているタグの値
Type : xsd: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:://cp.cloud.nifty.com/api/">
 <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
 <natTableSet>
  <item>
   <natTableId>nat-8db04f81</natTableId>
   <natRuleSet>
    <item>
     <natType>snat</natType>
     <ruleNumber>1</ruleNumber>
     <description>memo</description>
     <protocol>tcp</protocol>
     <outboundInterface>
      <networkId>net-8db04f81</networkId>
      <networkName>network001</networkName>
     </outboundInterface>
     <source>
      <address>172.16.10.12</addoress>
      <port>8080</port>
     </source>
     <translation>
      <port>8080</port>
     </translation>
    </item>
   </natRuleSet>
   <associationSet>
    <item>
     <associationId>natassoc-12ad487b</associationId>
     <natTableId>nat-8db04f81</natTableId>
     <routeId>rt-13ad487a</routed>
     <routerName>router1</routerName>
    </item>
   </associationSet>
  </item>
 </natTableSet>
</NiftyDescribeNatTablesResponse>

ニフティクラウド サイト内検索

APIメニュー

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

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