本文へジャンプします。

ニフクラ APIリファレンス

NiftyReplaceVpnGatewayLatestVersion

処理概要

指定したVPNゲートウェイを最新バージョンに入れ替えます。
入替前のVPNゲートウェイは、バックアップとして一定期間保持されます。 VPNゲートウェイを指定するためには、VPNゲートウェイユニークIDまたはVPNゲートウェイ名が必要です。処理中のVPNゲートウェイを指定した、管理外のVPNゲートウェイを指定した、既に最新バージョンのVPNゲートウェイを指定したなど、無効なVPNゲートウェイを指定した場合は、エラーが返されます。

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

指定するパラメーター

パラメーター 説明 必須 サンプル値
VpnGatewayId VPNゲートウェイユニークID
Type:String

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

(VPNゲートウェイユニークIDといずれか)
 
Agreement version up実施したのち、バックアップ状態を解除する事項への同意
Type: Boolean
Default:false

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

応答フィールド

フィールド(項目) 説明 サンプル値
NiftyReplaceVpnGatewayLatestVersionResponse NiftyReplaceVpnGatewayLatestVersionレスポンス
Type : NiftyReplaceVpnGatewayLatestVersionResponseType
Ancestor :なし
Children : requestId, return
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : NiftyReplaceVpnGatewayLatestVersionResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
return 処理ステータス
Type :xsd:boolean
Ancestor :NiftyReplaceVpnGatewayLatestVersionResponse
Children :なし
 

リクエストサンプル

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

応答サンプル

<NiftyReplaceVpnGatewayLatestVersionResponsexmlns="https://cp.cloud.nifty.com/api/">
 <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
 <return>true</return>
</NiftyReplaceVpnGatewayLatestVersionResponse>

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

APIメニュー

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

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