diff options
| author | Sean Dague <sean@dague.net> | 2016-04-12 09:03:46 -0400 |
|---|---|---|
| committer | Sean Dague <sean@dague.net> | 2016-04-13 07:34:45 -0400 |
| commit | d4e27714405e064ba8f62070e8c48d7fa71b6996 (patch) | |
| tree | bd8b560fdc3864ea1c121b069926cd6b1d569556 /api-ref/source/diagnostics.inc | |
| parent | f1fa7eb15a8b4a081d8d8afd3e6d80302c20e39e (diff) | |
| download | nova-d4e27714405e064ba8f62070e8c48d7fa71b6996.tar.gz | |
Import RST files for documentation
This is the results of the RST conversion from WADL. It creates a
single index plus a bunch of included files which represent sections
of the API document. This is the starting point for fixing the
documentation.
Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
Diffstat (limited to 'api-ref/source/diagnostics.inc')
| -rw-r--r-- | api-ref/source/diagnostics.inc | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/api-ref/source/diagnostics.inc b/api-ref/source/diagnostics.inc new file mode 100644 index 0000000000..dbaf517f17 --- /dev/null +++ b/api-ref/source/diagnostics.inc @@ -0,0 +1,38 @@ +.. -*- rst -*- + +============================================ + Servers diagnostics (servers, diagnostics) +============================================ + +Shows the usage data for a server. + +Show Server Diagnostics +======================= + +.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/diagnostics + +Shows basic usage data for a server. + +Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file. + +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 + + - tenant_id: tenant_id + - server_id: server_id + +Response +^^^^^^^^ + +**Example Server diagnostics: JSON response** + +.. literalinclude:: ../../doc/api_samples/diagnostics/server-diagnostics-show-resp.json + :language: javascript + |