2016-04-12 09:03:46 -04:00
|
|
|
.. -*- rst -*-
|
|
|
|
|
2016-05-10 16:59:57 -04:00
|
|
|
Evacuate Server (evacuate Action)
|
2016-04-12 09:03:46 -04:00
|
|
|
=================================
|
|
|
|
|
2016-06-02 08:50:03 -04:00
|
|
|
.. rest_method:: POST /servers/{server_id}/action
|
2016-04-12 09:03:46 -04:00
|
|
|
|
2016-05-10 16:59:57 -04:00
|
|
|
Evacuates a server from a failed host to a new host.
|
2016-04-12 09:03:46 -04:00
|
|
|
|
2016-05-10 16:59:57 -04:00
|
|
|
- Specify the ``evacuate`` action in the request body.
|
|
|
|
- In the request body, if ``onSharedStorage`` is set, then do not set ``adminPass``.
|
|
|
|
- The target host should not be the same as the instance host.
|
2016-04-12 09:03:46 -04:00
|
|
|
|
2016-04-20 15:34:02 +09:00
|
|
|
Normal response codes: 200
|
2016-04-12 09:03:46 -04:00
|
|
|
|
2017-04-17 16:20:12 +09:00
|
|
|
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
|
|
itemNotFound(404), conflict(409)
|
2016-04-12 09:03:46 -04:00
|
|
|
|
|
|
|
Request
|
2016-04-14 13:10:59 -04:00
|
|
|
-------
|
2016-04-12 09:03:46 -04:00
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
2016-10-10 14:50:17 -04:00
|
|
|
- server_id: server_id_path
|
2016-04-12 09:03:46 -04:00
|
|
|
- evacuate: evacuate
|
|
|
|
- host: host
|
2017-03-24 07:11:25 +00:00
|
|
|
- adminPass: adminPass_evacuate_request
|
2016-05-10 16:59:57 -04:00
|
|
|
- onSharedStorage: on_shared_storage
|
2016-05-18 21:58:06 +02:00
|
|
|
- force: force_evacuate
|
2016-05-10 16:59:57 -04:00
|
|
|
|
|
|
|
|
|
2016-04-12 09:03:46 -04:00
|
|
|
|
2016-10-10 14:50:17 -04:00
|
|
|
**Example Evacuate Server (evacuate Action)**
|
2016-04-12 09:03:46 -04:00
|
|
|
|
2016-04-20 15:34:02 +09:00
|
|
|
.. literalinclude:: ../../doc/api_samples/os-evacuate/server-evacuate-req.json
|
2016-04-12 09:03:46 -04:00
|
|
|
:language: javascript
|
|
|
|
|
2016-05-10 16:59:57 -04:00
|
|
|
|
2016-04-12 09:03:46 -04:00
|
|
|
Response
|
2016-04-14 13:10:59 -04:00
|
|
|
--------
|
2016-04-12 09:03:46 -04:00
|
|
|
|
2016-05-10 16:59:57 -04:00
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
2017-03-24 07:11:25 +00:00
|
|
|
- adminPass: adminPass_evacuate
|
|
|
|
|
|
|
|
.. note:: API does not return any Response for Microversion 2.14 or greater.
|
2016-05-10 16:59:57 -04:00
|
|
|
|
|
|
|
|
2016-10-10 14:50:17 -04:00
|
|
|
**Example Evacuate Server (evacuate Action)**
|
2016-04-12 09:03:46 -04:00
|
|
|
|
2016-04-20 15:34:02 +09:00
|
|
|
.. literalinclude:: ../../doc/api_samples/os-evacuate/server-evacuate-resp.json
|
2016-04-12 09:03:46 -04:00
|
|
|
:language: javascript
|