a369e30e08
* Unnecessary note is removed. * The 'on_shared_storage' parameter The max version is 2.13. Improve the description. * The 'evacuate' parameter Fix the type and the description. * The 'adminPass' parameter Fix the description and remove max version. * The 'host' parameter Improve the description. * response code Remove unncessary response codes. Add a missing response code. Change-Id: Ic857333ac25bee26e3ec22106b1b8fda2389b967 Implements: blueprint api-ref-in-rst-pike Closes-Bug: #1683264
53 lines
1.2 KiB
ReStructuredText
53 lines
1.2 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
Evacuate Server (evacuate Action)
|
|
=================================
|
|
|
|
.. rest_method:: POST /servers/{server_id}/action
|
|
|
|
Evacuates a server from a failed host to a new host.
|
|
|
|
- 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.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
itemNotFound(404), conflict(409)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- server_id: server_id_path
|
|
- evacuate: evacuate
|
|
- host: host
|
|
- adminPass: adminPass_evacuate_request
|
|
- onSharedStorage: on_shared_storage
|
|
- force: force_evacuate
|
|
|
|
|
|
|
|
|
**Example Evacuate Server (evacuate Action)**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-evacuate/server-evacuate-req.json
|
|
:language: javascript
|
|
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- adminPass: adminPass_evacuate
|
|
|
|
.. note:: API does not return any Response for Microversion 2.14 or greater.
|
|
|
|
|
|
**Example Evacuate Server (evacuate Action)**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-evacuate/server-evacuate-resp.json
|
|
:language: javascript
|