api-ref: Add descriptions for rebuild
Add descriptions about specifying a new image and asynchronous postconditions in the rebuild operation in the compute API reference. Change-Id: I0fd136d07dffc2be845b4b9330fae98c7115789b Closes-Bug: #1784387
This commit is contained in:
committed by
Matt Riedemann
parent
f9ad40d35d
commit
330c950908
@@ -480,10 +480,19 @@ Rebuilds a server.
|
||||
|
||||
Specify the ``rebuild`` action in the request body.
|
||||
|
||||
This operation recreates the root disk of the server.
|
||||
For a volume-backed server, this operation keeps the contents of the volume.
|
||||
|
||||
**Preconditions**
|
||||
|
||||
The server status must be ``ACTIVE``, ``SHUTOFF`` or ``ERROR``.
|
||||
|
||||
**Asynchronous Postconditions**
|
||||
|
||||
If the server was in status ``SHUTOFF`` before the rebuild, it will be stopped
|
||||
and in status ``SHUTOFF`` after the rebuild, otherwise it will be ``ACTIVE``
|
||||
if the rebuild was successful or ``ERROR`` if the rebuild failed.
|
||||
|
||||
.. note:: There is a `known limitation`_ where the root disk is not
|
||||
replaced for volume-backed instances during a rebuild.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user