本文へジャンプします。

ニフティクラウド APIリファレンス

RebootInstances

処理概要

指定したサーバーを再起動します。

サーバーを指定するためには、サーバー名が必要です。削除済みのサーバーを指定した、管理外のサーバーを指定したなど、無効なサーバーを指定した場合は、エラーが返されます。

サーバーの再起動には、時間がかかることがあります。サーバーのステータスは、API「DescribeInstances」のレスポンス値「instanceState」で確認できます。

NiftyIsBiosにtrueを指定すると、BIOS起動画面で停止した状態となります。コンソールからBIOS設定操作を行ってください。

指定するパラメーター

パラメーター 説明 必須 サンプル値
InstanceId.n サーバー名
Type : String
server01
UserData サーバー起動時スクリプト
Type: String
   
UserData.Encoding サーバー起動時スクリプトのエンコード
Type: String
値: なし(プレーンテキスト) | base64
Default: base64
   
Force 強制オプション
※「true」を指定すると、停止できない状態にあるサーバーで停止処理を強制実行する。
Type : Boolean
値 : true (強制実行) | false (強制実行しない) | None (強制実行しない)
   
NiftyIsBios BIOS画面起動の可否
Type : boolean
値 : true(BIOS起動画面で停止) | false(BIOS起動画面で停止しない)
Default : false
   
Tenancy.1 テナント属性
Type : String
値 : dafault (通常) | dedicated (専有) | all (全て)
Default : default
   

応答フィールド

フィールド(項目) 説明 サンプル値
RebootInstancesResponse RebootInstancesレスポンス
Type : RebootInstancesResponseType
Ancestor : なし
Children : requestId, return
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : RebootInstancesResponse
Children : なし
ad2adb5f-3b7a-4574-9b7d-8dd49f6dad4e
return 再起動ステータス
値 : true (成功)
Type : xsd:boolean
Ancestor : RebootInstancesResponse
Children : なし
true

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=RebootInstances&InstanceId.1=server01&CommonParams

応答サンプル

<RebootInstancesResponse xmlns="https://cp.cloud.nifty.com/api/">
  <requestId>ad2adb5f-3b7a-4574-9b7d-8dd49f6dad4e</requestId>
  <return>true</return>
</RebootInstancesResponse>

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

APIメニュー

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

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