本文へジャンプします。

ニフクラ APIリファレンス

NiftyReleaseVpnGatewayBackupState

処理概要

指定したVPNゲートウェイのバックアップ状態を解除します。
VPNゲートウェイを指定するためには、VPNゲートウェイユニークIDまたはVPNゲートウェイ名が必要です。処理中のVPNゲートウェイを指定した、管理外のVPNゲートウェイを指定した、バックアップを保持していないVPNゲートウェイを指定したなど、無効なVPNゲートウェイを指定した場合は、エラーが返されます。

バックアップを保持しているかどうかはAPI「DescribeVpnGateways」のレスポンス値「isBackup」で確認できます。

指定するパラメーター

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

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

(VPNゲートウェイユニークIDといずれか)
 

応答フィールド

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

リクエストサンプル

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

応答サンプル

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

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

APIメニュー

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

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