本文へジャンプします。

ニフクラ APIリファレンス

CreateVpnConnection

処理概要

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

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

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

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

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

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

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

指定するパラメーター

パラメーター 説明 必須 サンプル値
Type VPNコネクションタイプ
Type:String
値:IPsec | L2TPv3 /IPsec | VTI / IPsec
 
VpnGatewayId VPNゲートウェイユニークID
Type : String

(VPNゲートウェイ名といずれか)
 
NiftyVpnGatewayName VPNゲートウェイ名
Type : String

(VPNゲートウェイユニークIDといずれか)
 
CustomerGatewayId カスタマーゲートウェイユニークID
Type : String

(カスタマーゲートウェイ名といずれか)
 
NiftyCustomerGatewayName カスタマーゲートウェイ名
Type : String

(カスタマーゲートウェイユニークIDといずれか)
 
NiftyRemoteVpn.AccountName ※指定不可
Type : String
   
NiftyRemoteVpn.Password ※指定不可
Type : String
   
Options.StaticRoutesOnly ※指定不可
Type : Boolean
   
Options.NiftyIpIpTunnel ※指定不可
Type : Boolean
   
NiftyTunnel.Type トンネルタイプ
Type : String
値: L2TPv3

(TypeがL2TPv3 / IPsecの場合)
 
NiftyTunnel.Mode トンネルモード
Type : String
値: Unmanaged | Managed

(NiftyTunnel.Typeが設定されている場合)
 
NiftyTunnel.Encapsulation カプセル化
Type : String
値: IP(NiftyTunnel.ModeがUnmanagedの場合のみ指定可) | UDP

(NiftyTunnel.Typeが設定されている場合)
 
NiftyTunnel.TunnelId VPNゲートウェイ側トンネルID
Type : String

(NiftyTunnel.ModeがUnmanagedの場合)
 
NiftyTunnel.PeerTunnelId カスタマーゲートウェイ側トンネルID
Type : String

(NiftyTunnel.ModeがUnmanagedの場合)
 
NiftyTunnel.SessionId VPNゲートウェイ側セッションID
Type : String

(NiftyTunnel.ModeがUnmanagedの場合)
 
NiftyTunnel.PeerSessionId カスタマーゲートウェイ側セッションID
Type : String

(NiftyTunnel.ModeがUnmanagedの場合)
 
NiftyTunnel.SourcePort 送信元ポート(VPNゲートウェイ側ポート)
Type : String

(NiftyTunnel.ModeがUnmanagedの場合)
 
NiftyTunnel.DestinationPort 送信先ポート(カスタマーゲートウェイ側ポート)
Type : String

(NiftyTunnel.ModeがUnmanagedの場合)
 
NiftyIPsecConfiguration.EncryptionAlgorithm 暗号化アルゴリズム
Type : String
値: AES128 | AES256 | 3DES
Default: AES128
   
NiftyIPsecConfiguration.HashAlgorithm 認証アルゴリズム
Type : String
値: SHA1 | MD5
Default: SHA1
   
NiftyVpnConnectionMtu MTUサイズ
Type : String
Default: 1500
   
NiftyIPsecConfiguration.PreSharedKey 事前共有鍵
Type : String
Default : (システム発行)
   
NiftyIpsecConfiguration.InternetKeyExchange IKEプロトコル
Type:String
値:IKEv1 | IKEv2
Default:IKEv1
   
NiftyVpnConnectionDescription メモ
Type : String
   
Agreement version up実施したのち、バックアップ状態を解除する事項への同意
Type:boolean
Default:false

(バックアップを保持する場合のみ)
 

応答フィールド

フィールド(項目) 説明 サンプル値
CreateVpnConnectionResponse CreateVpnConnectionレスポンス
Type : CreateVpnConnectionResponseType
Ancestor : なし
Children : requestId, vpnConnection
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : CreateVpnConnectionResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
vpnConnection VPNコネクション情報
Type : VpnConnectionType
Ancestor : CreateVpnConnectionResponse
Children : vpnConnectionId,state,customerGatewayConfiguration,type,vpnGatewayId,niftyVpnGatewayName, customerGatewayId,niftyCustomerGatewayName,tagSet,vgwTelemetry,options,routes,niftyVpnConnectionDescription, createdTime,niftyTunnel,niftyIpsecConfiguration
 
vpnConnectionId VPNコネクションユニークID
Type : xsd:string
Ancestor : vpnConnection
Children : なし
 
state VPNコネクションステータス
Type : xsd:string
値: pending (処理中) | available (起動中) | stopped (停止済み) | warning (異常あり)
Ancestor : vpnConnection
Children : なし
 
customerGatewayConfiguration カスタマーゲートウェイに設定する情報(xml形式)
Type : xsd:string
Ancestor : vpnConnection
Children : なし
 
type VPNコネクションタイプ
Type : xsd:string
値: IPsec | L2TPv3 | IPsec | VTI / IPsec
Ancestor : vpnConnection
Children : なし
 
vpnGatewayId VPNゲートウェイユニークID
Type : xsd:string
Ancestor : vpnConnection
Children : なし
 
niftyVpnGatewayName VPNゲートウェイ名
Type : xsd:string
Ancestor : vpnConnection
Children : なし
 
customerGatewayId カスタマーゲートウェイユニークID
Type : xsd:string
Ancestor : vpnConnection
Children : なし
 
niftyCustomerGatewayName カスタマーゲートウェイ名
Type : xsd:string
Ancestor : vpnConnection
Children : なし
 
tagSet リソースに設定されているタグ情報セット
Type : ResourceTagSetType
Ancestor : vpnConnection
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 : vpnConnection
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 : vpnConnection
Children : staticRoutesOnly
 
staticRoutesOnly スタティックルーティングの使用可否
Type : xsd:boolean
Ancestor : options
Children : なし
 
routes VPNコネクションに対する静的ルーティング
Type : VpnStaticRouteType
Ancestor : vpnConnection
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 : vpnConnection
Children : なし
 
createdTime 作成日時
Type : xsd:DateTime
Ancestor : vpnConnection
Children : なし
 
niftyTunnel トンネル情報
Type : NiftyTunnelType
Ancestor : vpnConnection
Children : type,mode,encapsulation,tunnelId,peerTunnelId,sessionId,peerSessionId,sorcePort,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 : vpnConnection
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 :niftyIpPsecConfiguration
Children :なし
 
mtu MTUサイズ
Type : xsd:string
Ancestor : niftyIpsecConfiguration
Children : なし
 

リクエストサンプル(拠点VPNの場合)

https://cp.cloud.nifty.com/api/?Action=CreateVpnConnection&Type=IPsec&VpnGatewayId=vgw-8db04f81&CustomerGatewayId=cgw-b4dc3961&CommonParams

応答サンプル(拠点VPNの場合)

<CreateVpnConnectionResponse xmlns="https://cp.cloud.nifty.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <vpnConnection>
    <vpnConnectionId>vpn-44a8938f</vpnConnectionId>
    <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/>
  </vpnConnection>
</CreateVpnConnectionResponse>

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

APIメニュー

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

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