RebootInstances
処理概要
指定したサーバーを再起動します。
サーバーを指定するためには、サーバー名が必要です。
サーバーの再起動には、時間がかかることがあります。サーバーのステータスは、API「DescribeInstances」のレスポンス値「instanceState」で確認できます。
NiftyIsBiosにtrueを指定すると、BIOS起動画面で停止した状態となります。コンソールからBIOS設定操作を行ってください。
UserDataを指定してリクエストする場合は、POSTのみの対応となりますので、ご注意ください。
指定するパラメーター
| パラメーター | 型 | 説明 | 必須 |
|---|---|---|---|
| InstanceId.n | string |
サーバー名 |
○ |
| UserData | string |
サーバー起動時スクリプト |
|
| UserData.Encoding | string |
サーバー起動時スクリプトのエンコード Default: base64 |
|
| Force | boolean |
強制オプション ※「true」を指定すると、停止できない状態にあるサーバーで停止処理を強制実行する。 値: true (強制実行) | false (強制実行しない) Default: False |
|
| NiftyIsBios | boolean |
BIOS画面起動の可否 値: True (BIOS起動画面で停止) | False (BIOS起動画面で停止しない) Default: False |
|
| Tenancy.n | string |
テナント属性 値: default (通常) | dedicated (専有) Default: default |
応答フィールド
| フィールド (項目) | 型 | 説明 |
|---|---|---|
| RebootInstancesResponse | - |
RebootInstancesレスポンス Ancestor: なし Children: requestId | return |
| requestId | string |
リクエスト識別子 Ancestor: RebootInstancesResponse Children: なし |
| return | boolean |
処理ステータス 値: true(成功) Ancestor: RebootInstancesResponse Children: なし |
リクエストサンプル
https://jp-east-1.computing.api.nifcloud.com/api/
?Action=RebootInstances
&InstanceId.1=server01
&CommonParams
応答サンプル
<RebootInstancesResponse xmlns="https://computing.api.nifcloud.com/api/">
<requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
<return>true</return>
</RebootInstancesResponse>
