summaryrefslogtreecommitdiff
path: root/api-guide
diff options
context:
space:
mode:
authorZuul <zuul@review.openstack.org>2018-05-30 21:52:23 +0000
committerGerrit Code Review <review@openstack.org>2018-05-30 21:52:23 +0000
commitb36d3175240533beeb79c7d1a404a2555051f2f0 (patch)
tree97ee784fa5c4c0b42110ff473a63a55545c9c7cb /api-guide
parent9b3ef30d738ae6537d9e17374cd3e28870da6f25 (diff)
parent88f86e24e121ba545012051b6587d7475bfc5cec (diff)
downloadnova-b36d3175240533beeb79c7d1a404a2555051f2f0.tar.gz
Merge "doc: cleanup API guide about instance faults"
Diffstat (limited to 'api-guide')
-rw-r--r--api-guide/source/faults.rst20
1 files changed, 18 insertions, 2 deletions
diff --git a/api-guide/source/faults.rst b/api-guide/source/faults.rst
index d8cf063889..8a88fa429e 100644
--- a/api-guide/source/faults.rst
+++ b/api-guide/source/faults.rst
@@ -109,8 +109,24 @@ Instance Faults
Nova often adds an instance fault DB entry for an exception that happens
while processing an API request. This often includes more administrator
-focused information, such as a stack trace.
-However, there is currently no API to retrieve this information.
+focused information, such as a stack trace. For a server with status
+``ERROR`` or ``DELETED``, a ``GET /servers/{server_id}`` request will include
+a ``fault`` object in the response body for the ``server`` resource. For
+example::
+
+ GET https://10.211.2.122/compute/v2.1/servers/c76a7603-95be-4368-87e9-7b9b89fb1d7e
+ {
+ "server": {
+ "id": "c76a7603-95be-4368-87e9-7b9b89fb1d7e",
+ "fault": {
+ "created": "2018-04-10T13:49:40Z",
+ "message": "No valid host was found.",
+ "code": 500
+ },
+ "status": "ERROR",
+ ...
+ }
+ }
Notifications
-------------