Stop server
Method | URI | Description |
---|---|---|
POST | /v2/{tenant_id}/servers/{server_id}/action | 起動状態のサーバを停止します。リクエストボディでos-stopアクションを指定してください。 |
Normal response codes: 202
注意:
- IaaSポータル/APIから仮想サーバを「停止」した場合、一定時間内にシャットダウン処理が完了しないと仮想サーバが強制停止(電源強制断に相当)されます。正常に停止状態にするには、仮想サーバにログインしてシャットダウン操作を実施してください。
-
「/etc/cloud/cloud.cfg」に以下の設定がない場合は、「/etc/cloud/cloud.cfg.d/datasource.cfg」を作成して追加してください。すでに設定済の場合は、対応する必要はありません。
datasource_list: ['OpenStack']
Request
下表は、サーバ停止リクエストのURIパラメーターの一覧です。
Name | Type | Description |
---|---|---|
{tenant_id} | String | プロジェクトID |
{server_id} | UUID | 対象とする仮想サーバの仮想サーバID |
下表は、サーバ停止リクエストのボディ部のパラメーターの一覧です。
Name | Type | Description |
---|---|---|
os-stop | none | os-stopアクションとして、キーに "os-stop" を指定し、値に "null" を指定します。 |
Example. Stop server: JSON request
{
"os-stop": null
}
Response
本操作ではリクエストボディ部の指定は不要です。