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

NiftyUpdateVpnGatewayNetworkInterfaces

処理概要

拠点間VPNゲートウェイのネットワーク設定変更をします。
拠点間VPNゲートウェイを指定するためには、拠点間VPNゲートウェイIDまたは拠点間VPNゲートウェイ名が必要です。

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

指定するパラメーター

パラメーター	型	説明	必須
VpnGatewayId	string	拠点間VPNゲートウェイユニークID	○ (拠点間VPNゲートウェイ名といずれか)
NiftyVpnGatewayName	string	拠点間VPNゲートウェイ名	○ (拠点間VPNゲートウェイユニークIDといずれか)
NetworkInterface.IpAddress	string	プライベート側IPアドレス	○ (NetworkInterface.n.NetworkIdかNetworkInterface.n.NetworkNameのいずれか)
NetworkInterface.n.NetworkId	string	ネットワークID 使用可能文字: net-COMMON_GLOBAL(共通グローバル)、プライベートLANのネットワークID	○ (NetworkInterface.IpAddressとNetworkInterface.n.NetworkNameといずれか)
NetworkInterface.n.NetworkName	string	ネットワーク名 Default: なし	○ (NetworkInterface.IpAddressかNetworkInterface.n.NetworkIdのいずれか)
NetworkInterface.n.IpAddress	string	IPアドレス Default: なし
NetworkInterface.n.IsOutsideNetwork	boolean	対向機器側のネットワークフラグ 値: true (対向機器側ネットワーク) false (プライベート側ネットワーク)	○ (NetworkInterface.n.NetworkIdか NetworkInterface.n.NetworkName を指定した場合)
NiftyReboot	string	再起動オプション 値: force (強制再起動) true (通常再起動) Default: true
Agreement	boolean	version up実施したのち、バックアップ状態を解除する事項への同意 値: true (同意する) false (同意しない) Default: false	○ (バックアップを保持する場合のみ)

応答フィールド

フィールド (項目)	型	説明
NiftyUpdateVpnGatewayNetworkInterfacesResponse	-	NiftyUpdateVpnGatewayNetworkInterfacesレスポンス
␣requestId	string	リクエスト識別子
␣return	boolean	処理ステータス 値: true (成功)

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=NiftyUpdateVpnGatewayNetworkInterfaces
  &NiftyVpnGatewayName=vpn1
  &NetworkInterface.1.IsOutsideNetwork=true
  &NetworkInterface.1.NetworkId=net-COMMON_GLOBAL
  &NetworkInterface.2.IpAddress=192.168.0.2
  &NetworkInterface.2.IsOutsideNetwork=false
  &NetworkInterface.2.NetworkName=priNw1l
  &NiftyReboot=force
  &CommonParams

  

応答サンプル

    <NiftyUpdateVpnGatewayNetworkInterfacesResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <return>true</return>
</NiftyUpdateVpnGatewayNetworkInterfacesResponse>