本文へジャンプします。

ニフクラ APIリファレンス

NiftyReleaseRouterBackupState

処理概要

ルーターのバックアップ状態を解除します。

ルーターを指定するためには、ルーターユニークIDまたはルーター名が必要です。処理中のルーターを指定した、削除済みのルーターを指定した、管理外のルーターを指定した、バックアップを保持していないルーターを指定したなど、無効なルーターを指定した場合は、エラーが返されます。

バックアップを保持しているかどうかはAPI「NiftyDescribeRouters」のレスポンス値「isBackup」で確認できます。

指定するパラメーター

パラメーター 説明 必須 サンプル値
RouterId ルーターユニークID
Type : String

(ルーター名といずれか)
 
RouterName ルーター名
Type : String

(ルーターユニークIDといずれか)
 

応答フィールド

フィールド(項目) 説明 サンプル値
NiftyReleaseRouterBackupStateResponse NiftyReleaseRouterBackupState レスポンス
Type : NiftyReleaseRouterBackupStateResponseType
Ancestor : なし
Children : requestId, return
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : NiftyReleaseRouterBackupStateResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
return 処理結果
Type :xsd:boolean
Ancestor :NiftyReleaseRouterBackupStateResponse
Children :なし
 

リクエストサンプル

https://jp-east-1.computing.api.nifcloud.com/api/?Action=NiftyReleaseRouterBackupState&RouterName=router1&CommonParams

応答サンプル

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

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

APIメニュー

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

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