本文へジャンプします。

ニフクラ ユーザーガイド

DescribeVpnConnections

処理概要

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

VPNコネクションを指定するためには、VPNコネクションユニークIDが必要です。
削除済みのVPNコネクションを指定した、管理外のVPNコネクションを指定したなど、無効なVPNコネクションを指定した場合は、エラーが返されます。
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 DescribeVpnConnectionsResponseType DescribeVpnConnectionsレスポンス
Ancestor: なし
Children: requestId | vpnConnectionSet
requestId string リクエスト識別子
Ancestor: DescribeVpnConnectionsResponse
Children: なし
vpnConnectionSet VpnConnectionSetType VPN接続情報セット
Ancestor: DescribeVpnConnectionsResponse
Children: item
item VpnConnectionType VPNコネクション情報
Ancestor: vpnConnectionSet
Children: vpnConnectionId | state | customerGatewayConfiguration | type | vpnGatewayId | niftyVpnGatewayName | customerGatewayId | niftyCustomerGatewayName | tagSet | vgwTelemetry | options | routes | niftyVpnConnectionDescription | createdTime | niftyTunnel | niftyIpsecConfiguration
vpnConnectionId string VPNコネクションユニークID
Ancestor: item
Children: なし
state string VPNコネクションステータス
値: pending (処理中) | available (起動中)
Ancestor: item
Children: なし
customerGatewayConfiguration string カスタマーゲートウェイに設定する情報(xml形式)
Ancestor: item
Children: なし
type string VPNコネクションタイプ
値: IPsec | L2TPv3 / IPsec | IPsec VTI
Ancestor: item
Children: なし
vpnGatewayId string 拠点間VPNゲートウェイユニークID
Ancestor: item
Children: なし
niftyVpnGatewayName string 拠点間VPNゲートウェイ名
Ancestor: item
Children: なし
customerGatewayId string カスタマーゲートウェイユニークID
Ancestor: item
Children: なし
niftyCustomerGatewayName string カスタマーゲートウェイ名
Ancestor: item
Children: なし
tagSet ResourceTagSetType リソースに設定されているタグ情報セット
Ancestor: item
Children: item
item ResourceTagSetItemType リソースに設定されているタグ情報
Ancestor: tagSet
Children: key | value
key string 設定されているタグのキー
Ancestor: item
Children: なし
value string 設定されているタグの値
Ancestor: item
Children: なし
vgwTelemetry VpnTunnelTelemetryType 拠点間VPNゲートウェイ情報セット
Ancestor: item
Children: item
item VpnTunnelTelemetryItemType 拠点間VPNゲートウェイ情報
Ancestor: vgwTelemetry
Children: outsideIpAddress | status | lastStatusChange | statusMessage | acceptedRouteCount
outsideIpAddress string 拠点間VPNゲートウェイのインターネット側IPアドレス
Ancestor: item
Children: なし
status string VPNの接続ステータス
値: UP | DOWN
Ancestor: item
Children: なし
lastStatusChange timestamp 最終変更日付
Ancestor: item
Children: なし
statusMessage string エラーが出ていた場合のメッセージ
Ancestor: item
Children: なし
acceptedRouteCount integer 設定されたルート数
Ancestor: item
Children: なし
options VpnConnectionOptionsResponseType VPNコネクションオプション
Ancestor: item
Children: staticRoutesOnly
staticRoutesOnly boolean スタティックルーティングの使用可否
Ancestor: options
Children: なし
routes VpnStaticRouteType VPNコネクションに対する静的ルーティング
Ancestor: item
Children: destinationCidrBlock | source | state
destinationCidrBlock string 宛先CIDRブロック
Ancestor: routes
Children: なし
source string ルーティングの種別
Ancestor: routes
Children: なし
state string 静的ルーティングのステータス
値: pending (処理中) | available (起動中) | stopped (停止済み) | warning (異常あり)
Ancestor: routes
Children: なし
niftyVpnConnectionDescription string メモ
Ancestor: item
Children: なし
createdTime timestamp 作成日時
Ancestor: item
Children: なし
niftyTunnel NiftyTunnelType トンネル情報
Ancestor: item
Children: type | mode | encapsulation | tunnelId | peerTunnelId | sessionId | peerSessionId | sourcePort | destinationPort
type string トンネルのタイプ
値: L2TPv3
Ancestor: niftyTunnel
Children: なし
mode string トンネルのモード
値: Unmanaged | Managed
Ancestor: niftyTunnel
Children: なし
encapsulation string カプセル化
値: IP | UDP
Ancestor: niftyTunnel
Children: なし
tunnelId string 拠点間VPNゲートウェイ側トンネルID
Ancestor: niftyTunnel
Children: なし
peerTunnelId string カスタマーゲートウェイ側トンネルID
Ancestor: niftyTunnel
Children: なし
sessionId string 拠点間VPNゲートウェイ側セッションID
Ancestor: niftyTunnel
Children: なし
peerSessionId string カスタマーゲートウェイ側セッションID
Ancestor: niftyTunnel
Children: なし
sourcePort string 送信元ポート(拠点間VPNゲートウェイ側ポート)
Ancestor: niftyTunnel
Children: なし
destinationPort string 送信先ポート(カスタマーゲートウェイ側ポート)
Ancestor: niftyTunnel
Children: なし
niftyIpsecConfiguration NiftyIpsecConfigurationType 設定情報
Ancestor: item
Children: encryptionAlgorithm | hashingAlgorithm | preSharedKey | internetKeyExchange | mtu | internetKeyExchangeLifetime | encapsulationSecurityPayloadLifetime | diffieHellmanGroup
encryptionAlgorithm string 暗号化アルゴリズム
値: AES128 | AES256 | 3DES
Ancestor: niftyIpsecConfiguration
Children: なし
hashingAlgorithm string 認証アルゴリズム
値: SHA1 | SHA256 | SHA384 | SHA512 | MD5
Ancestor: niftyIpsecConfiguration
Children: なし
preSharedKey string 事前共有鍵
Ancestor: niftyIpsecConfiguration
Children: なし
internetKeyExchange string IKEプロトコル
値: IKEv1 | IKEv2
Ancestor: niftyIpsecConfiguration
Children: なし
mtu string MTUサイズ
Ancestor: niftyIpsecConfiguration
Children: なし
internetKeyExchangeLifetime integer IKE SAの有効期限
Ancestor: niftyIpsecConfiguration
Children: なし
encapsulationSecurityPayloadLifetime integer ESP SAの有効期限
Ancestor: niftyIpsecConfiguration
Children: なし
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)
Ancestor: niftyIpsecConfiguration
Children: なし

リクエストサンプル

    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/>
      <type>IPsec</type>
      <vpnGatewayId>vgw-8db04f81</vpnGatewayId>
      <niftyVpnGatewayName>vpngw1</niftyVpnGatewayName>
      <customerGatewayId>cgw-b4dc3961</customerGatewayId>
      <niftyCustomerGatewayName>customergw1</niftyCustomerGatewayName>
      <vgwTelemetry/>
      <options>
        <staticRoutesOnly>false</staticRoutesOnly>
      </options>
      <routes/>
      <niftyIpsecConfiguration>
        <encryptionAlgorithm>3DES</encryptionAlgorithm>
        <hashingAlgorithm>MD5</hashingAlgorithm>
        <preSharedKey/>
        <mtu>1500</mtu>
        <internetKeyExchange>IKEv1</internetKeyExchange>
        <internetKeyExchangeLifetime>28800</internetKeyExchangeLifetime>
        <encapsulationSecurityPayloadLifetime>3600</encapsulationSecurityPayloadLifetime>
        <diffieHellmanGroup>2</diffieHellmanGroup>
      </niftyIpsecConfiguration>
      <niftyVpnConnectionDescription/>
    </item>
    <item>
      <vpnConnectionId>vpn-8db04f81</vpnConnectionId>
      <state>available</state>
      <customerGatewayConfiguration/>
      <type>IPsec</type>
      <vpnGatewayId>vgw-8db04f81</vpnGatewayId>
      <niftyVpnGatewayName>vpngw1</niftyVpnGatewayName>
      <niftyRemoteVpn>
        <accountName>multiAccount</accountName>
        <password>xxxxxx</password>
      </niftyRemoteVpn>
      <tagSet/>
      <vgwTelemetry/>
      <options>
        <staticRoutesOnly>false</staticRoutesOnly>
        <niftyIpIpTunnel>false</niftyIpIpTunnel>
      </options>
      <routes/>
      <niftyIpsecConfiguration>
        <encryptionAlgorithm>3DES</encryptionAlgorithm>
        <hashingAlgorithm>MD5</hashingAlgorithm>
        <preSharedKey/>
        <mtu>1500</mtu>
        <internetKeyExchange>IKEv1</internetKeyExchange>
        <internetKeyExchangeLifetime>28800</internetKeyExchangeLifetime>
        <encapsulationSecurityPayloadLifetime>3600</encapsulationSecurityPayloadLifetime>
        <diffieHellmanGroup>2</diffieHellmanGroup>
      </niftyIpsecConfiguration>
      <niftyVpnConnectionDescription/>
    </item>
  </vpnConnectionSet>
</DescribeVpnConnectionsResponse>

  

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

APIメニュー

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

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