本文へジャンプします。

ニフクラ APIリファレンス

NiftyRebootVpnGateways

処理概要

指定したVPNゲートウェイを再起動します。
VPNゲートウェイを指定するためには、VPNゲートウェイユニークIDまたはVPNゲートウェイ名が必要です。処理中のVPNゲートウェイを指定した、削除済みのVPNゲートウェイを指定した、管理外のVPNゲートウェイを指定したなど、無効なVPNゲートウェイを指定した場合は、エラーが返されます。
VPNゲートウェイの再起動には、時間がかかることがあります。VPNゲートウェイのステータスは、API「DescribeVpnGateways」のレスポンス値「state」で確認できます。

指定するパラメーター

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

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

(VPNゲートウェイユニークIDといずれか)
 
VpnGateway.n.NiftyReboot 再起動オプション
Type : String
値 : force(強制再起動) | true(通常再起動)
Default: true
   

応答フィールド

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

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=NiftyRebootVpnGateways&VpnGateway.1.VpnGatewayId=vgw-8db04f81&CommonParams

応答サンプル

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

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

APIメニュー

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

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