NiftyRebootVpnGateways
処理概要
指定した拠点間VPNゲートウェイを再起動します。
拠点間VPNゲートウェイを指定するためには、拠点間VPNゲートウェイユニークIDまたは拠点間VPNゲートウェイ名が必要です。
拠点間VPNゲートウェイの再起動には、時間がかかることがあります。拠点間VPNゲートウェイのステータスは、API「DescribeVpnGateways」のレスポンス値「state」で確認できます。
指定するパラメーター
パラメーター | 型 | 説明 | 必須 |
---|---|---|---|
VpnGateway.n.VpnGatewayId | string |
拠点間VPNゲートウェイユニークID |
○ (拠点間VPNゲートウェイ名といずれか) |
VpnGateway.n.NiftyVpnGatewayName | string |
拠点間VPNゲートウェイ名 |
○ (拠点間VPNゲートウェイユニークIDといずれか) |
VpnGateway.n.NiftyReboot | string |
再起動オプション 値: force (強制再起動) | true (通常再起動) Default: true |
応答フィールド
フィールド (項目) | 型 | 説明 |
---|---|---|
NiftyRebootVpnGatewaysResponse | - |
NiftyRebootVpnGatewaysレスポンス Ancestor: なし Children: requestId | return |
requestId | string |
リクエスト識別子 Ancestor: NiftyRebootVpnGatewaysResponse Children: なし |
return | boolean |
処理ステータス 値: true(成功) Ancestor: NiftyRebootVpnGatewaysResponse Children: なし |
リクエストサンプル
https://jp-east-1.computing.api.nifcloud.com/api/
?Action=NiftyRebootVpnGateways
&VpnGateway.1.VpnGatewayId=vgw-8db04f81
&CommonParams
応答サンプル
<NiftyRebootVpnGatewaysResponse xmlns="https://computing.api.nifcloud.com/api/">
<requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
<return>true</return>
</NiftyRebootVpnGatewaysResponse>