NiftyRestoreRouterPreviousVersion
処理概要
指定したルーターを、以前の旧バージョン(バックアップ状態)に差し戻します入れ替えを実施します。 ルーターを指定するためには、ルーターユニークIDまたはルーター名が必要です。処理中のルーターを指定した、削除済みのルーターを指定した、管理外のルーターを指定した、バックアップを保持していないルーターを指定したなど、無効なルーターを指定した場合は、エラーが返されます。
バックアップを保持しているかどうかはAPI「NiftyDescribeRouters」のレスポンス値「isBackup」で確認できます。
指定するパラメーター
パラメーター | 説明 | 必須 | サンプル値 |
---|---|---|---|
RouterId | ルーターユニークID Type : String |
○ (ルーター名といずれか) |
|
RouterName | ルーター名 Type : String |
○ (ルーターユニークIDといずれか) |
応答フィールド
フィールド(項目) | 説明 | サンプル値 |
---|---|---|
NiftyRestoreRouterPreviousVersionResponse | NiftyRestoreRouterPreviousVersion レスポンス Type : NiftyRestoreRouterPreviousVersionResponseType Ancestor : なし Children : requestId, return |
|
requestId | リクエスト識別子 Type : xsd:string Ancestor : NiftyRestoreRouterPreviousVersionResponse Children : なし |
ac501097-4c8d-475b-b06b-a90048ec181c |
return | 処理結果 Type :xsd:boolean Ancestor :NiftyRestoreRouterPreviousVersionResponse Children :なし |
リクエストサンプル
https://cp.cloud.nifty.com/api/?Action=NiftyRestoreRouterPreviousVersion&RouterName=router1&CommonParams
応答サンプル
<NiftyRestoreRouterPreviousVersionResponse xmlns="https://cp.cloud.nifty.com/api/">
<requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
<return>true</return>
</NiftyRestoreRouterPreviousVersionResponse>