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

CreateVpnGateway

処理概要

拠点間VPNゲートウェイを新規作成します。

指定するパラメーター

パラメーター	型	説明	必須
NiftyVpnGatewayName	string	拠点間VPNゲートウェイ名 Default: 英数8文字 (システム発行)
Type	string	※指定不可
NiftyVpnGatewayType	string	拠点間VPNゲートウェイのタイプ 値: small medium large Default: small
NiftyRedundancy	boolean	※指定不可 冗長化オプション 値: true false
Placement.AvailabilityZone	string	ゾーン名 Default: ニフクラが決定
AccountingType	string	利用料金タイプ 値: 1 (月額課金) 2 (従量課金) Default: 2
NiftyVpnGatewayDescription	string	メモ
NiftyNetwork.NetworkId	string	プライベート側ネットワークID	○ (NiftyNetwork.NetworkNameかNetworkInterface.n.NetworkIdとNetworkInterface.n.NetworkNameのいずれかのみ)
NiftyNetwork.NetworkName	string	プライベート側ネットワーク名	○ (NiftyNetwork.NetworkIdとNetworkInterface.n.NetworkIdかNetworkInterface.n.NetworkNameのいずれかのみ)
NiftyNetwork.IpAddress	string	プライベート側IPアドレス(IPv4)
NetworkInterface.n.NetworkId	string	ネットワークID 使用可能文字: net-COMMON_GLOBAL(共通グローバル)、プライベートLANのネットワークID	○ (NiftyNetwork.NetworkIdとNiftyNetwork.NetworkNameかNetworkInterface.n.NetworkNameのいずれかのみ)
NetworkInterface.n.NetworkName	string	ネットワーク名 Default: なし	○ (NiftyNetwork.NetworkIdとNiftyNetwork.NetworkNameかNetworkInterface.n.NetworkIdのいずれかのみ)
NetworkInterface.n.IpAddress	string	IPアドレス Default: なし
NetworkInterface.n.IsOutsideNetwork	boolean	対向機器側のネットワークフラグ 値: true (対向機器側ネットワーク) false (プライベート側ネットワーク)	○ (NetworkInterface.n.NetworkIdか NetworkInterface.n.NetworkName を指定した場合)
SecurityGroup.n	string	ファイアウォールグループ名

応答フィールド

フィールド (項目)	型	説明
CreateVpnGatewayResponse	-	CreateVpnGatewayレスポンス
␣requestId	string	リクエスト識別子
␣vpnGateway	-	拠点間VPNゲートウェイ情報
␣␣vpnGatewayId	string	拠点間VPNゲートウェイユニークID
␣␣niftyVpnGatewayName	string	拠点間VPNゲートウェイ名
␣␣state	string	拠点間VPNゲートウェイステータス 値: pending (処理中) available (起動中) stopped (停止済み) warning (異常あり)
␣␣availabilityZone	string	ゾーン名
␣␣niftyVpnGatewayType	string	拠点間VPNゲートウェイのタイプ 値: small medium large
␣␣niftyRedundancy	boolean	冗長化オプション 値: false
␣␣niftyVpnGatewayDescription	string	メモ(CDATA付)
␣␣accountingType	string	利用料金タイプ 値: 1 (月額課金) 2 (従量課金)
␣␣nextMonthAccountingType	string	翌月の利用料金タイプ 値: 1 (月額課金) 2 (従量課金)
␣␣versionInformation	-	拠点間VPNゲートウェイのversion情報
␣␣␣isLatest	boolean	拠点間VPNゲートウェイのversion最新状態
␣␣␣version	string	拠点間VPNゲートウェイのversion情報
␣␣networkInterfaceSet	-	ネットワークインターフェイス情報セット
␣␣␣item	-	ネットワークインターフェイス情報
␣␣␣␣networkId	string	ネットワークユニークID
␣␣␣␣networkName	string	ネットワーク名
␣␣␣␣ipAddress	string	IPアドレス
␣␣␣␣isOutsideNetwork	boolean	対向機器側のネットワークフラグ
␣␣backupInformation	-	バックアップ情報セット
␣␣␣isBackup	boolean	バックアップが存在するか
␣␣groupSet	-	ファイアウォール情報セット
␣␣␣item	-	ファイアウォール情報
␣␣␣␣groupId	string	ファイアウォールグループ名

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=CreateVpnGateway
  &NiftyVpnGatewayName=vpn1
  &NiftyVpnGatewayType=small
  &Placement.AvailabilityZone=east-11
  &NetworkInterface.1.NetworkId=net-COMMON_GLOBAL
  &NetworkInterface.1.IsOutsideNetwork=true
  &NetworkInterface.2.NetworkName=priNw1l
  &NetworkInterface.2.IsOutsideNetwork=false
  &NetworkInterface.2.IpAddress=192.168.0.1
  &SecurityGroup.1=group01
  &CommonParams

  

応答サンプル

    <CreateVpnGatewayResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <vpnGateway>
    <vpnGatewayId>vgw-8db04f81</vpnGatewayId>
    <niftyVpnGatewayName>vpn1</niftyVpnGatewayName>
    <state>pending</state>
    <availabilityZone>east-11</availabilityZone>
    <niftyVpnGatewayType>small</niftyVpnGatewayType>
    <niftyRedundancy>false</niftyRedundancy>
    <niftyVpnGatewayDescription><![CDATA[]]></niftyVpnGatewayDescription>
    <accountingType>2</accountingType>
    <nextMonthAccountingType>2</nextMonthAccountingType>
    <versionInformation>
      <isLatest>true</isLatest>
      <version>v3.2</version>
    </versionInformation>
    <networkInterfaceSet>
      <item>
        <networkId>net-COMMON_GLOBAL</networkId>
        <isOutsideNetwork>true</isOutsideNetwork>
      </item>
      <item>
        <networkName>priNw1l</networkName>
        <ipAddress>192.168.0.1</ipAddress>
        <isOutsideNetwork>false</isOutsideNetwork>
      </item>
    </networkInterfaceSet>
    <backupInformation>
      <isBackup>false</isBackup>
    </backupInformation>
    <groupSet>
      <item>
        <groupId>group01</groupId>
      </item>
    </groupSet>
  </vpnGateway>
</CreateVpnGatewayResponse>