本文へジャンプします。

ニフクラ ユーザーガイド

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 以上から利用可能)
値: 30~86400
Default: 28800
NiftyIpsecConfiguration.EncapsulatingSecurityPayloadLifeTime integer ESP SAの有効期限(拠点間VPNゲートウェイバージョン v3.0 以上から利用可能)
値: 30~86400
Default: 3600
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実施したのち、バックアップ状態を解除する事項への同意
Default: True
○ (バックアップを保持する場合のみ)

応答フィールド

フィールド (項目) 説明
CreateVpnConnectionResponse CreateVpnConnectionResponseType CreateVpnConnectionレスポンス
Ancestor: なし
Children: requestId | vpnConnection
requestId string リクエスト識別子
Ancestor: CreateVpnConnectionResponse
Children: なし
vpnConnection VpnConnectionType VPNコネクション情報
Ancestor: CreateVpnConnectionResponse
Children: vpnConnectionId | state | customerGatewayConfiguration | type | vpnGatewayId | niftyVpnGatewayName | customerGatewayId | niftyCustomerGatewayName | tagSet | vgwTelemetry | options | routes | niftyVpnConnectionDescription | createdTime | niftyTunnel | niftyIpsecConfiguration
vpnConnectionId string VPNコネクションユニークID
Ancestor: vpnConnection
Children: なし
state string VPNコネクションステータス
値: pending (処理中) | available (起動中)
Ancestor: vpnConnection
Children: なし
customerGatewayConfiguration string カスタマーゲートウェイに設定する情報(xml形式)
Ancestor: vpnConnection
Children: なし
type string VPNコネクションタイプ
値: IPsec | L2TPv3 / IPsec | IPsec VTI
Ancestor: vpnConnection
Children: なし
vpnGatewayId string 拠点間VPNゲートウェイユニークID
Ancestor: vpnConnection
Children: なし
niftyVpnGatewayName string 拠点間VPNゲートウェイ名
Ancestor: vpnConnection
Children: なし
customerGatewayId string カスタマーゲートウェイユニークID
Ancestor: vpnConnection
Children: なし
niftyCustomerGatewayName string カスタマーゲートウェイ名
Ancestor: vpnConnection
Children: なし
tagSet ResourceTagSetType リソースに設定されているタグ情報セット
Ancestor: vpnConnection
Children: item
item ResourceTagSetItemType リソースに設定されているタグ情報
Ancestor: tagSet
Children: key | value
key string 設定されているタグのキー
Ancestor: item
Children: なし
value string 設定されているタグの値
Ancestor: item
Children: なし
vgwTelemetry VpnTunnelTelemetryType 拠点間VPNゲートウェイ情報セット
Ancestor: vpnConnection
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: vpnConnection
Children: staticRoutesOnly
staticRoutesOnly boolean スタティックルーティングの使用可否
Ancestor: options
Children: なし
routes VpnStaticRouteType VPNコネクションに対する静的ルーティング
Ancestor: vpnConnection
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: vpnConnection
Children: なし
createdTime timestamp 作成日時
Ancestor: vpnConnection
Children: なし
niftyTunnel NiftyTunnelType トンネル情報
Ancestor: vpnConnection
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: vpnConnection
Children: encryptionAlgorithm | hashingAlgorithm | preSharedKey | internetKeyExchange | mtu | internetKeyExchangeLifeTime | encapsulatingSecurityPayloadLifeTime | 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: なし
encapsulatingSecurityPayloadLifeTime 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=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>
    <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>
      <encapsulatingSecurityPayloadLifeTime>3600</encapsulatingSecurityPayloadLifeTime>
      <diffieHellmanGroup>2</diffieHellmanGroup>
    </niftyIpsecConfiguration>
    <niftyVpnConnectionDescription/>
  </vpnConnection>
</CreateVpnConnectionResponse>

  

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

APIメニュー

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

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