本文へジャンプします。

ニフクラ ユーザーガイド

本ページは2023/9/5をもって、新ページhttps://docs.nifcloud.com/cp/api/DescribeVpnConnections.htmへ移行しました。 今後は新ページをご参照ください。

DescribeVpnConnections

処理概要

指定されたVPNコネクションの情報を取得します。

VPNコネクションを指定するためには、VPNコネクションユニークIDが必要です。
VPNコネクションを指定しない場合、取得できるすべてのVPNコネクション情報を取得します。

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

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

  • customer-gateway-configuration
  • nifty-customer-gateway-name
  • route.destination-cidr-block
  • nifty-vpn-gateway-name
  • nifty-vpn-connection-description

指定するパラメーター

パラメーター 説明 必須
VpnConnectionId.n string VPNコネクションユニークID
Filter.n.Name string 絞り込み条件の項目名
値:
  • customer-gateway-configuration (カスタマーゲートウェイに設定する情報)
  • customer-gateway-id (カスタマーゲートウェイユニークID)
  • nifty-customer-gateway-name (カスタマーゲートウェイ名)
  • state (VPNコネクションステータス)
  • option.static-routes-only (スタティックルーティングの使用可否)
  • route.destination-cidr-block (宛先CIDRブロック)
  • type (VPNコネクションタイプ)
  • vpn-connection-id (VPNコネクションユニークID)
  • vpn-gateway-id (拠点間VPNゲートウェイユニークID)
  • nifty-vpn-gateway-name (拠点間VPNゲートウェイ名)
  • nifty-vpn-connection-description (VPNコネクションメモ)
  • nifty-internet-key-exchange (IKEプロトコル)
Filter.n.Value.m string 絞り込み条件の値

応答フィールド

フィールド (項目) 説明
DescribeVpnConnectionsResponse - DescribeVpnConnectionsレスポンス
requestId string リクエスト識別子
vpnConnectionSet - VPN接続情報セット
item - VPNコネクション情報
vpnConnectionId string VPNコネクションユニークID
state string VPNコネクションステータス
値:
  • pending (処理中)
  • available (起動中)
customerGatewayConfiguration string カスタマーゲートウェイに設定する情報(CDATA付き)
type string VPNコネクションタイプ
値:
  • IPsec
  • L2TPv3 / IPsec
  • IPsec VTI
vpnGatewayId string 拠点間VPNゲートウェイユニークID
niftyVpnGatewayName string 拠点間VPNゲートウェイ名
customerGatewayId string カスタマーゲートウェイユニークID
niftyCustomerGatewayName string カスタマーゲートウェイ名
tagSet - ※空を返却
item - リソースに設定されているタグ情報
key string 設定されているタグのキー
value string 設定されているタグの値
vgwTelemetry - 拠点間VPNゲートウェイ情報セット
item - 拠点間VPNゲートウェイ情報
outsideIpAddress string 拠点間VPNゲートウェイのインターネット側IPアドレス
status string VPNの接続ステータス
値:
  • UP
  • DOWN
lastStatusChange timestamp 最終変更日付
statusMessage string エラーが出ていた場合のメッセージ
acceptedRouteCount integer 設定されたルート数
niftyVpnConnectionDescription string メモ
createdTime timestamp 作成日時
niftyTunnel - トンネル情報
type string トンネルのタイプ
値:
  • L2TPv3
mode string トンネルのモード
値:
  • Unmanaged
  • Managed
encapsulation string カプセル化
値:
  • IP
  • UDP
tunnelId string 拠点間VPNゲートウェイ側トンネルID
peerTunnelId string カスタマーゲートウェイ側トンネルID
sessionId string 拠点間VPNゲートウェイ側セッションID
peerSessionId string カスタマーゲートウェイ側セッションID
sourcePort string 送信元ポート(拠点間VPNゲートウェイ側ポート)
destinationPort string 送信先ポート(カスタマーゲートウェイ側ポート)
niftyIpsecConfiguration - 設定情報
encryptionAlgorithm string 暗号化アルゴリズム
値:
  • AES128
  • AES256
  • 3DES
hashingAlgorithm string 認証アルゴリズム
値:
  • SHA1
  • SHA256
  • SHA384
  • SHA512
  • MD5
preSharedKey string 事前共有鍵(CDATA付き)
internetKeyExchange string IKEプロトコル
値:
  • IKEv1
  • IKEv2
mtu string MTUサイズ
internetKeyExchangeLifetime integer IKE SAの有効期限
encapsulatingSecurityPayloadLifetime integer ESP SAの有効期限
diffieHellmanGroup integer IKE, PFSそれぞれのDiffie-Hellman Group
備考: 返却値 2 (1024-bit MODP group),5 (1536-bit MODP group),14 (2048-bit MODP group),15 (3072-bit MODP group),16 (4096-bit MODP group),17 (6144-bit MODP group),18 (8192-bit MODP group),19 (256-bit random ECP group),20 (384-bit random ECP group),21 (512-bit random ECP group),22 (1024-bit MODP Group with 160-bit Prime Order Subgroup),23 (2048-bit MODP Group with 224-bit Prime Order Subgroup),24 (2048-bit MODP Group with 256-bit Prime Order Subgroup),25 (192-bit Random ECP Group),26 (224-bit Random ECP Group)

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/?
  Action=DescribeCustomerGateways
  &Filter.1.Name=state
  &Filter.1.Value.1=available
  &CommonParams

  

応答サンプル

    <DescribeVpnConnectionsResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>f6dd8353-eb6b-6b4fd32e4f05</requestId>
  <vpnConnectionSet>
    <item>
      <vpnConnectionId>vpn-44a8938f</vpnConnectionId>
      <state>available</state>
      <customerGatewayConfiguration><![CDATA[<Configuration></Configuration>]]></customerGatewayConfiguration>
      <type>IPsec</type>
      <vpnGatewayId>vgw-8db04f81</vpnGatewayId>
      <niftyVpnGatewayName>vpngw1</niftyVpnGatewayName>
      <customerGatewayId>cgw-b4dc3961</customerGatewayId>
      <niftyCustomerGatewayName>customergw1</niftyCustomerGatewayName>
      <tagSet />
      <vgwTelemetry>
        <item>
          <acceptedRouteCount>0</acceptedRouteCount>
          <lastStatusChange>2020-06-26T10:07:55.648+09:00</lastStatusChange>
          <outsideIpAddress>203.0.113.1</outsideIpAddress>
          <status>DOWN</status>
          <statusMessage></statusMessage>
        </item>
      </vgwTelemetry>
      <createdTime>2020-06-23T16:35:24+09:00</createdTime>
      <niftyTunnel>
        <type>L2TPv3</type>
        <mode>Unmanaged</mode>
        <encapsulation>UDP</encapsulation>
        <tunnelId>1</tunnelId>
        <peerTunnelId>2</peerTunnelId>
        <sessionId>1</sessionId>
        <peerSessionId>2</peerSessionId>
        <sourcePort>7777</sourcePort>
        <destinationPort>7777</destinationPort>
      </niftyTunnel>
      <niftyIpsecConfiguration>
        <encryptionAlgorithm>3DES</encryptionAlgorithm>
        <hashingAlgorithm>MD5</hashingAlgorithm>
        <preSharedKey><![CDATA[key]]></preSharedKey>
        <mtu>1500</mtu>
        <internetKeyExchange>IKEv1</internetKeyExchange>
        <internetKeyExchangeLifetime>28800</internetKeyExchangeLifetime>
        <encapsulatingSecurityPayloadLifetime>3600</encapsulatingSecurityPayloadLifetime>
        <diffieHellmanGroup>2</diffieHellmanGroup>
      </niftyIpsecConfiguration>
      <niftyVpnConnectionDescription>description</niftyVpnConnectionDescription>
    </item>
  </vpnConnectionSet>
</DescribeVpnConnectionsResponse>

  

ニフクラ サイト内検索

APIメニュー

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

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