本文へジャンプします。

ニフクラ APIリファレンス

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 VPNコネクションユニークID
Type : String
   
Filter.n.Name 絞り込み条件の項目名
Type : 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 絞り込み条件の値
Type : String
   

応答フィールド

フィールド(項目) 説明 サンプル値
DescribeVpnConnectionsResponse DescribeVpnConnectionsレスポンス
Type : DescribeVpnConnectionsResponseType
Ancestor : なし
Children : requestId, vpnConnectionSet
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : DescribeVpnConnectionsResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
vpnConnectionSet VPN接続情報セット
Type : VpnConnectionSetType
Ancestor : DescribeVpnConnectionsResponse
Children : item
 
item VPNコネクション情報
Type : VpnConnectionType
Ancestor : vpnConnectionSet
Children : vpnConnectionId,state,customerGatewayConfiguration,type, vpnGatewayId,niftyVpnGatewayName,customerGatewayId, niftyCustomerGatewayName,tagSet,vgwTelemetry,options,routes, niftyVpnConnectionDescription,createdTime,niftyTunnel,niftyIpsecConfiguration
 
vpnConnectionId VPNコネクションユニークID
Type : xsd:string
Ancestor : item
Children : なし
 
state VPNコネクションステータス
Type : xsd:string
値: pending (処理中) | available (起動中)
Ancestor : item
Children : なし
 
customerGatewayConfiguration カスタマーゲートウェイに設定する情報(xml形式)
Type : xsd:string
Ancestor : item
Children : なし
 
type VPNコネクションタイプ
Type : xsd:string
値: IPsec | L2TPv3 | IPsec | VTI / IPsec
Ancestor : item
Children : なし
 
vpnGatewayId VPNゲートウェイユニークID
Type : xsd:string
Ancestor : item
Children : なし
 
niftyVpnGatewayName VPNゲートウェイ名
Type : xsd:string
Ancestor : item
Children : なし
 
customerGatewayId カスタマーゲートウェイユニークID
Type : xsd:string
Ancestor : item
Children : なし
 
niftyCustomerGatewayName カスタマーゲートウェイ名
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 : なし
 
vgwTelemetry VPNゲートウェイ情報セット
Type : VpnTunnelTelemetryType
Ancestor : item
Children : item
 
item VPNゲートウェイ情報
Type : VpnTunnelTelemetryItemType
Ancestor : vgwTelemetry
Children : outsideIpAddress,status,lastStatusChange,statusMessage,acceptedRouteCount
 
outsideIpAddress VPNゲートウェイのインターネット側IPアドレス
Type : xsd:string
Ancestor : item
Children : なし
 
status VPNの接続ステータス
Type : xsd:string
値: UP | DOWN
Ancestor : item
Children : なし
 
lastStatusChange 最終変更日付
Type : xsd:dateTime
Ancestor : item
Children : なし
 
statusMessage エラーが出ていた場合のメッセージ
Type : xsd:string
Ancestor : item
Children : なし
 
acceptedRouteCount 設定されたルート数
Type : xsd:integer
Ancestor : item
Children : なし
 
options VPNコネクションオプション
Type : VpnConnectionOptionsResponseType
Ancestor : item
Children : staticRoutesOnly
 
staticRoutesOnly スタティックルーティングの使用可否
Type : xsd:boolean
Ancestor : options
Children : なし
 
routes VPNコネクションに対する静的ルーティング
Type : VpnStaticRouteType
Ancestor : item
Children : destinationCidrBlock,source,state
 
destinationCidrBlock 宛先CIDRブロック
Type : xsd:string
Ancestor : routes
Children : なし
 
source ルーティングの種別
Type : xsd:string
Ancestor : routes
Children : なし
 
state 静的ルーティングのステータス
Type : xsd:string
値: pending (処理中) | available (起動中) | stopped (停止済み) | warning (異常あり) Ancestor : routes
Children : なし
 
niftyVpnConnectionDescription メモ
Type : xsd:string
Ancestor : item
Children : なし
 
createdTime 作成日時
Type : xsd: dateTime
Ancestor : item
Children : なし
 
niftyTunnel トンネル情報
Type : NiftyTunnelType
Ancestor : item
Children : type,mode,encapsulation,tunnelId,peerTunnelId,sessionId,peerSessionId,sourcePort,destinationPort
 
type トンネルのタイプ
Type : xsd:string
値: L2TPv3
Ancestor : niftyTunnel
Children : なし
 
mode トンネルのモード
Type : xsd:string
値: Unmanaged | Managed
Ancestor : niftyTunnel
Children : なし
 
encapsulation カプセル化
Type : xsd:string
値: IP | UDP
Ancestor : niftyTunnel
Children : なし
 
tunnelId VPNゲートウェイ側トンネルID
Type : xsd:string
Ancestor : niftyTunnel
Children : なし
 
peerTunnelId カスタマーゲートウェイ側トンネルID
Type : xsd:string
Ancestor : niftyTunnel
Children : なし
 
sessionId VPNゲートウェイ側セッションID
Type : xsd:string
Ancestor : niftyTunnel
Children : なし
 
peerSessionId カスタマーゲートウェイ側セッションID
Type : xsd:string
Ancestor : niftyTunnel
Children : なし
 
sourcePort 送信元ポート(VPNゲートウェイ側ポート)
Type : xsd:string
Ancestor : niftyTunnel
Children : なし
 
destinationPort 送信先ポート(カスタマーゲートウェイ側ポート)
Type : xsd:string
Ancestor : niftyTunnel
Children : なし
 
niftyIpsecConfiguration 設定情報
Type : NiftyIpsecConfigurationType
Ancestor : item
Children :encryptionAlgorithm,hashingAlgorithm,preSharedKey,internetKeyExchange, mtu
 
encryptionAlgorithm 暗号化アルゴリズム
Type : xsd:string
値: AES128 | AES256 | 3DES
Ancestor : niftyIpsecConfiguration
Children : なし
 
hashingAlgorithm 認証アルゴリズム
Type : xsd:string
値: SHA1 | MD5
Ancestor : niftyIpsecConfiguration
Children : なし
 
preSharedKey 事前共有鍵
Type : xsd:string
Ancestor : niftyIpsecConfiguration
Children : なし
 
internetKeyExchange IKEプロトコル
Type :xsd:string
値:IKEv1 | IKEv2
Ancestor :niftyIpsecConfiguration
Children :なし
 
mtu MTUサイズ
Type : xsd:string
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://cp.cloud.nifty.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</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/>
        <internetKeyExchange>IKEv1</internetKeyExchange>
      </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/>
        <internetKeyExchange>IKEv1</internetKeyExchange>
      </niftyIpsecConfiguration>
      <niftyVpnConnectionDescription/>
    </item>
  </vpnConnectionSet>
</DescribeVpnConnectionsResponse>

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

APIメニュー

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

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