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

【重要なお知らせ】サービス統合に基づくサービス名称の読み替えのお願い（2024年4月1日）

2024年4月1日をもって、「ニフクラ」は、「FJcloud-V」に統合し、名称を変更しました。
当サイトのアドレス（ドメイン名）に含まれる「nifcloud.com」は現時点では変更はございませんが、
各ページに記載の「ニフクラ」「NIFCLOUD」「nifcloud」は、「FJcloud-V」に読み替えていただきますようお願いいたします。

ニフクラユーザーガイド

クラウドトップ>コンピューティング> API> CreateVpnConnection

CreateVpnConnection

処理概要

VPNコネクションを新規作成します。
拠点間VPN設定（拠点間VPNゲートウェイとカスタマーゲートウェイ間）を行います。

トンネルモードを「Managed」に指定した場合、以下の項目は指定ができません。

NiftyTunnel.TunnelId、NiftyTunnel.PeerTunnelId、NiftyTunnel.SessionId、NiftyTunnel.PeerSessionId、NiftyTunnel.SourcePort、NiftyTunnel.DestinationPort

またトンネルモードが「Unmanaged」でかつカプセル化が「IP」の場合は、以下の項目は指定ができません。

NiftyTunnel.SourcePort、NiftyTunnel.DestinationPort

またトンネルタイプが設定されていない場合は、MTUサイズは指定ができません。

指定した拠点間VPNゲートウェイがバックアップを保持している場合は、パラメーター「Agreement」に「true」を設定し、バックアップを解除する必要があります。バックアップを保持しているかどうかはAPI「DescribeVpnGateways」のレスポンス値「isBackup」で確認できます。

指定するパラメーター

パラメーター	型	説明	必須
Type	string	VPNコネクションタイプ値: IPsec L2TPv3 / IPsec IPsec VTI	○
VpnGatewayId	string	拠点間VPNゲートウェイユニークID	○ (拠点間VPNゲートウェイ名といずれか)
NiftyVpnGatewayName	string	拠点間VPNゲートウェイ名	○ (拠点間VPNゲートウェイユニークIDといずれか)
CustomerGatewayId	string	カスタマーゲートウェイユニークID	○ (カスタマーゲートウェイ名といずれか)
NiftyCustomerGatewayName	string	カスタマーゲートウェイ名	○ (カスタマーゲートウェイユニークIDといずれか)
NiftyTunnel.Type	string	トンネルタイプ値: L2TPv3	○ (TypeがL2TPv3/IPsecの場合)
NiftyTunnel.Mode	string	トンネルモード値: Unmanaged Managed	○ (NiftyTunnel.Typeが設定されている場合)
NiftyTunnel.Encapsulation	string	カプセル化値: IP (NiftyTunnel.ModeがUnmanagedの場合のみ指定可) UDP	○ (NiftyTunnel.Typeが設定されている場合)
NiftyTunnel.TunnelId	string	拠点間VPNゲートウェイ側トンネルID	○ (NiftyTunnel.ModeがUnmanagedの場合)
NiftyTunnel.PeerTunnelId	string	カスタマーゲートウェイ側トンネルID	○ (NiftyTunnel.ModeがUnmanagedの場合)
NiftyTunnel.SessionId	string	拠点間VPNゲートウェイ側セッションID	○ (NiftyTunnel.ModeがUnmanagedの場合)
NiftyTunnel.PeerSessionId	string	カスタマーゲートウェイ側セッションID	○ (NiftyTunnel.ModeがUnmanagedの場合)
NiftyTunnel.SourcePort	string	送信元ポート（拠点間VPNゲートウェイ側ポート）	○ (NiftyTunnel.ModeがUnmanagedの場合)
NiftyTunnel.DestinationPort	string	送信先ポート（カスタマーゲートウェイ側ポート）	○ (NiftyTunnel.ModeがUnmanagedの場合)
NiftyIpsecConfiguration.EncryptionAlgorithm	string	暗号化アルゴリズム値: AES128 AES256 3DES Default: AES128
NiftyIpsecConfiguration.HashAlgorithm	string	認証アルゴリズム値: SHA1 MD5 SHA256 SHA384 SHA512 Default: SHA1
NiftyVpnConnectionMtu	string	MTUサイズ Default: 1500
NiftyIpsecConfiguration.PreSharedKey	string	事前共有鍵 Default: （システム発行）
NiftyIpsecConfiguration.InternetKeyExchange	string	IKEプロトコル値: IKEv1 IKEv2 Default: IKEv1
NiftyIpsecConfiguration.InternetKeyExchangeLifetime	integer	IKE SAの有効期限（拠点間VPNゲートウェイバージョン v3.0 以上から利用可能）単位: 秒 Default: 28800 使用可能文字: 30～86400
NiftyIpsecConfiguration.EncapsulatingSecurityPayloadLifetime	integer	ESP SAの有効期限（拠点間VPNゲートウェイバージョン v3.0 以上から利用可能）単位: 秒 Default: 3600 使用可能文字: 30～86400
NiftyIpsecConfiguration.DiffieHellmanGroup	integer	IKE, PFSそれぞれのDiffie-Hellman Group（拠点間VPNゲートウェイバージョン v3.0 以上から利用可能）値: 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) Default: 2
NiftyVpnConnectionDescription	string	メモ
Agreement	boolean	version up実施したのち、バックアップ状態を解除する事項への同意値: true (同意する) false (同意しない) Default: false	○ (バックアップを保持する場合のみ)

応答フィールド

フィールド (項目)	型	説明
CreateVpnConnectionResponse	-	CreateVpnConnectionレスポンス
␣requestId	string	リクエスト識別子
␣vpnConnection	-	VPNコネクション情報
␣␣vpnConnectionId	string	VPNコネクションユニークID
␣␣state	string	VPNコネクションステータス値: pending (処理中) available (起動中)
␣␣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	事前共有鍵
␣␣␣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=CreateVpnConnection
  &Type=IPsec
  &VpnGatewayId=vgw-8db04f81
  &CustomerGatewayId=cgw-b4dc3961
  &CommonParams

応答サンプル

    <CreateVpnConnectionResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>f6dd8353-eb6b-6b4fd32e4f05</requestId>
  <vpnConnection>
    <vpnConnectionId>vpn-44a8938f</vpnConnectionId>
    <type>IPsec</type>
    <vpnGatewayId>vgw-8db04f81</vpnGatewayId>
    <customerGatewayId>cgw-b4dc3961</customerGatewayId>
    <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>
  </vpnConnection>
</CreateVpnConnectionResponse>