本文へジャンプします。

ニフクラ ユーザーガイド

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レスポンス
Ancestor: なし
Children: requestId | vpnGatewaySet
requestId string リクエスト識別子
Ancestor: DescribeVpnGatewaysResponse
Children: なし
vpnGatewaySet - 拠点間VPNゲートウェイ情報セット
Ancestor: DescribeVpnGatewaysResponse
Children: item
item - 拠点間VPNゲートウェイ情報
Ancestor: vpnGatewaySet
Children: vpnGatewayId | niftyVpnGatewayName | state | availabilityZone | attachments | tagSet | niftyVpnGatewayType | niftyRedundancy | niftyVpnGatewayDescription | accountingType | nextMonthAccountingType | networkInterfaceSet | groupSet | createdTime | versionInformation | backupInformation | routeTableId | routeTableAssociationId
vpnGatewayId string 拠点間VPNゲートウェイユニークID
Ancestor: item
Children: なし
niftyVpnGatewayName string 拠点間VPNゲートウェイ名
Ancestor: item
Children: なし
state string 拠点間VPNゲートウェイステータス
値: pending(処理中) | available(起動中) | stopped(停止済み) | warning(異常あり)
Ancestor: item
Children: なし
availabilityZone string ゾーン名
Ancestor: item
Children: なし
attachments 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: なし
niftyVpnGatewayType string 拠点間VPNゲートウェイのタイプ
Ancestor: item
Children: なし
niftyRedundancy boolean 冗長化オプション
Ancestor: item
Children: なし
niftyVpnGatewayDescription string メモ(CDATA付)
Ancestor: item
Children: なし
accountingType string 利用料金タイプ
値: 1(月額課金) | 2(従量課金)
Ancestor: item
Children: なし
nextMonthAccountingType string 次月からの利用料金タイプ
値: 1(月額課金) | 2(従量課金)
Ancestor: item
Children: なし
versionInformation - 拠点間VPNゲートウェイのversion情報
Ancestor: item
Children: isLatest | version
isLatest boolean 拠点間VPNゲートウェイのversion最新状態
Ancestor: versionInformation
Children: なし
version string 拠点間VPNゲートウェイのversion情報
Ancestor: versionInformation
Children: なし
networkInterfaceSet - ネットワークインターフェイス情報セット
Ancestor: item
Children: item
item - ネットワークインターフェイス情報
Ancestor: networkInterfaceSet
Children: networkId | networkName | deviceIndex | ipAddress | cidrBlock | descriprion
networkId string ネットワークユニークID
Ancestor: item
Children: なし
networkName string ネットワーク名
Ancestor: item
Children: なし
deviceIndex integer デバイス番号
Ancestor: item
Children: なし
ipAddress string IPアドレス
Ancestor: item
Children: なし
cidrBlock string ネットワークのCIDR
Ancestor: item
Children: なし
descriprion string ネットワークのメモ(CDATA付)
Ancestor: item
Children: なし
backupInformation - バックアップ情報セット
Ancestor: item
Children: expirationDate | isBackup
expirationDate timestamp バックアップの保持期限
Ancestor: backupInformation
Children: なし
isBackup boolean バックアップが存在するか
Ancestor: backupInformation
Children: なし
groupSet - ファイアウォール情報セット
Ancestor: item
Children: item
item - ファイアウォール情報
Ancestor: groupSet
Children: groupId
groupId string ファイアウォールグループ名
Ancestor: item
Children: なし
routeTableId string ルートテーブルID
Ancestor: item
Children: なし
routeTableAssociationId string ルートテーブル適用ID
Ancestor: item
Children: なし
createdTime timestamp 作成日時
Ancestor: item
Children: なし

リクエストサンプル

    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>
        </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>
          <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>

  

ニフクラ サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2020年11月25日時点の情報です。

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