78dee1de59
This commit fix the below doc issue for adminPass -'adminPass' attrbiure is only return in response if 'enable_instance_password' configuration option is set to true - evacuate API stop returning adminPass from 2.14 microversion so max version for this field is 2.13. - if 'adminPass' is not present in request then, operation auto generate one. Change-Id: I636657ed30b33da0a2df73b222c4ce5d8388a3d8
54 lines
1.3 KiB
ReStructuredText
54 lines
1.3 KiB
ReStructuredText
.. note:: Microversion 2.23 or greater is required for this API.
|
|
.. -*- 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_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
|