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

NiftyReplaceVpnGatewayLatestVersion

処理概要

指定した拠点間VPNゲートウェイを最新バージョンに入れ替えます。
入替前の拠点間VPNゲートウェイは、バックアップとして一定期間保持されます。拠点間VPNゲートウェイを指定するためには、拠点間VPNゲートウェイユニークIDまたは拠点間VPNゲートウェイ名が必要です。

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

指定するパラメーター

パラメーター	型	説明	必須
VpnGatewayId	string	拠点間VPNゲートウェイユニークID	○ (拠点間VPNゲートウェイ名といずれか)
NiftyVpnGatewayName	string	拠点間VPNゲートウェイ名	○ (拠点間VPNゲートウェイユニークIDといずれか)
Agreement	boolean	version up実施したのち、バックアップ状態を解除する事項への同意 値: true (同意する) false (同意しない) Default: false	○ (バックアップを保持する場合のみ)

応答フィールド

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

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=NiftyReplaceVpnGatewayLatestVersion
  &VpnGatewayId=vgw-8db04f81
  &Agreement=true
  &CommonParams

  

応答サンプル

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