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://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>
