ニフクラAPI (コンピューティング: DescribeVpnGateways)

DescribeVpnGateways

処理概要

指定した拠点間VPNゲートウェイの情報を取得します。
拠点間VPNゲートウェイを指定するためには、拠点間VPNゲートウェイユニークIDまたは拠点間VPNゲートウェイ名が必要です。
拠点間VPNゲートウェイを指定しない場合、取得できるすべての拠点間VPNゲートウェイ情報を取得します。

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

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

• nifty-vpn-gateway-name
• nifty-vpn-gateway-description

指定するパラメーター

パラメーター	型	説明	必須
VpnGatewayId.n	string	拠点間VPNゲートウェイユニークID
NiftyVpnGatewayName.n	string	拠点間VPNゲートウェイ名
Filter.n.Name	string	絞り込み条件の項目名 値: attachment.state (接続状態) attachment.vpc-id availability-zone (ゾーン) state (拠点間VPNゲートウェイステータス) type (VPN接続方式) vpn-gateway-id (拠点間VPNゲートウェイユニークID) nifty-vpn-gateway-name (拠点間VPNゲートウェイ名) nifty-vpn-gateway-type (拠点間VPNゲートウェイタイプ) nifty-vpn-gateway-description (拠点間VPNゲートウェイメモ) nifty-vpn-gateway-accountingType (拠点間VPNゲートウェイ利用料金タイプ) ip-address (拠点間VPNゲートウェイのIPアドレス) latest-version-information (拠点間VPNゲートウェイルータのversionの更新情報) version (ルータ拠点間VPNゲートウェイのversion情報)
Filter.n.Value.m	string	絞り込み条件の値

応答フィールド

フィールド (項目)	型	説明
DescribeVpnGatewaysResponse	-	DescribeVpnGatewayレスポンス
␣requestId	string	リクエスト識別子
␣vpnGatewaySet	-	拠点間VPNゲートウェイ情報セット
␣␣item	-	拠点間VPNゲートウェイ情報
␣␣␣vpnGatewayId	string	拠点間VPNゲートウェイユニークID
␣␣␣niftyVpnGatewayName	string	拠点間VPNゲートウェイ名
␣␣␣state	string	拠点間VPNゲートウェイステータス 値: pending (処理中) available (起動中) stopped (停止済み) warning (異常あり)
␣␣␣availabilityZone	string	ゾーン名
␣␣␣attachments	string	※空を返却
␣␣␣tagSet	-	※空を返却 リソースに設定されているタグ情報セット
␣␣␣␣item	-	リソースに設定されているタグ情報
␣␣␣␣␣key	string	設定されているタグのキー
␣␣␣␣␣value	string	設定されているタグの値
␣␣␣niftyVpnGatewayType	string	拠点間VPNゲートウェイのタイプ
␣␣␣niftyRedundancy	boolean	冗長化オプション
␣␣␣niftyVpnGatewayDescription	string	メモ(CDATA付)
␣␣␣accountingType	string	利用料金タイプ 値: 1 (月額課金) 2 (従量課金)
␣␣␣nextMonthAccountingType	string	次月からの利用料金タイプ 値: 1 (月額課金) 2 (従量課金)
␣␣␣networkInterfaceSet	-	ネットワークインターフェイス情報セット
␣␣␣␣item	-	ネットワークインターフェイス情報
␣␣␣␣␣networkId	string	ネットワークユニークID
␣␣␣␣␣networkName	string	ネットワーク名
␣␣␣␣␣deviceIndex	string	デバイス番号
␣␣␣␣␣ipAddress	string	IPアドレス
␣␣␣␣␣cidrBlock	string	ネットワークのCIDR
␣␣␣␣␣isOutsideNetwork	boolean	対向機器側のネットワークフラグ
␣␣␣␣␣description	string	ネットワークのメモ(CDATA付)
␣␣␣groupSet	-	ファイアウォール情報セット
␣␣␣␣item	-	ファイアウォール情報
␣␣␣␣␣groupId	string	ファイアウォールグループ名
␣␣␣createdTime	timestamp	作成日時
␣␣␣versionInformation	-	拠点間VPNゲートウェイのversion情報
␣␣␣␣isLatest	boolean	拠点間VPNゲートウェイのversion最新状態
␣␣␣␣version	string	拠点間VPNゲートウェイのversion情報
␣␣␣backupInformation	-	バックアップ情報セット
␣␣␣␣expirationDate	timestamp	バックアップの保持期限
␣␣␣␣isBackup	boolean	バックアップが存在するか
␣␣␣routeTableId	string	ルートテーブルID
␣␣␣routeTableAssociationId	string	ルートテーブル適用ID

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=DescribeVpnGateways
  &VpnGatewayId.1=vgw-8db04f81
  &Filter.1.Name=state
  &Filter.1.Value.1=available
  &CommonParams

  

応答サンプル

    <DescribeVpnGatewaysResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <vpnGatewaySet>
    <item>
      <vpnGatewayId>vgw-8db04f81</vpnGatewayId>
      <niftyVpnGatewayName>create01</niftyVpnGatewayName>
      <state>available</state>
      <availabilityZone>east-11</availabilityZone>
      <attachments/>
      <tagSet/>
      <niftyVpnGatewayType>medium</niftyVpnGatewayType>
      <niftyRedundancy>false</niftyRedundancy>
      <niftyVpnGatewayDescription><![CDATA[1]]></niftyVpnGatewayDescription>
      <accountingType>1</accountingType>
      <nextMonthAccountingType>2</nextMonthAccountingType>
      <versionInformation>
        <isLatest>true</isLatest>
        <version>vyos 1.1.5</version>
      </versionInformation>
      <networkInterfaceSet>
        <item>
          <networkId>net-COMMON_GLOBAL</networkId>
          <networkName></networkName>
          <deviceIndex>0</deviceIndex>
          <ipAddress>111.171.134.162</ipAddress>
          <isOutsideNetwork>true</isOutsideNetwork>
        </item>
        <item>
          <networkId>net-0nzh8np7</networkId>
          <networkName>network6</networkName>
          <deviceIndex>0</deviceIndex>
          <ipAddress>192.168.100.1</ipAddress>
          <cidrBlock>192.168.100.0/24</cidrBlock>
          <isOutsideNetwork>false</isOutsideNetwork>
          <description><![CDATA[1]]></description>
        </item>
      </networkInterfaceSet>
      <backupInformation>
        <expirationDate>2015/01/15</expirationDate>
        <isBackup>true</isBackup>
      </backupInformation>
      <groupSet>
        <item>
          <groupId>group01</groupId>
        </item>
      </groupSet>
      <routeTableId>rt-01234567</routeTableId>
      <routeTableAssociationId>rtbassoc-01234567</routeTableAssociationId>
      <createdTime>2015-01-15T14:02:21+09:00</createdTime>
    </item>
  </vpnGatewaySet>
</DescribeVpnGatewaysResponse>