NiftyRebootRouters
処理概要
指定したルーターを再起動をします。
ルーターを指定するためには、ルーターユニークID またはルーター名が必要です。処理中のルーターを指定した、削除済みのル
ーターを指定した、管理外のルーターを指定したなど、無効なルーターを指定した場合は、エラーが返されます。
ルーターの再起動には、時間がかかることがあります。ルーターのステータスは、API「NiftyDescribeRouters」のレスポンス値「state」で確認できます。
指定するパラメーター
| パラメーター | 説明 | 必須 | サンプル値 |
|---|---|---|---|
| Router.n.RouterId | ルーターユニークID Type : String |
○ (ルーター名といずれか) |
|
| Router.n.RouterName | ルーター名 Type : String |
○ (ルーターユニークIDといずれか) |
|
| Router.n.NiftyReboot | 再起動オプション Type : String 値:force（強制再起動） | true（通常再起動） Default: true |
応答フィールド
| フィールド（項目） | 説明 | サンプル値 |
|---|---|---|
| NiftyRebootRoutersResponse | NiftyRebootRouters レスポンス Type : NiftyRebootRoutersResponseType Ancestor : なし Children : requestId, return |
|
| requestId | リクエスト識別子 Type : xsd:string Ancestor : NiftyRebootRoutersResponse Children : なし |
ac501097-4c8d-475b-b06b-a90048ec181c |
| return | 処理ステータス Type : xsd:boolean Ancestor : NiftyRebootRoutersResponse Children : なし |
リクエストサンプル
https://jp-east-1.computing.api.nifcloud.com/api/?Action=NiftyRebootRouters&RouterId.1=rt-8db04f81&CommonParams応答サンプル
<NiftyRebootRoutersResponse xmlns="https://cp.cloud.nifty.com/api/">
<requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
<return>true</return>
</NiftyRebootRoutersResponse>
