168a500570
- Update server_id params to be of type path. - Cleaned up os-getConsoleOutput action string. - Made empty response body description more consistent. Review and change as needed. Implements: bp/api-ref-in-rst-ocata Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4
52 lines
1.2 KiB
ReStructuredText
52 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: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
|
|
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- server_id: server_id_path
|
|
- evacuate: evacuate
|
|
- host: host
|
|
- adminPass: adminPass_evacuate_rebuild_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_rebuild
|
|
|
|
|
|
|
|
|
**Example Evacuate Server (evacuate Action)**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-evacuate/server-evacuate-resp.json
|
|
:language: javascript
|