c9f5ad3bcf
As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
45 lines
1.1 KiB
ReStructuredText
45 lines
1.1 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
============================================
|
|
Servers diagnostics (servers, diagnostics)
|
|
============================================
|
|
|
|
Shows the usage data for a server.
|
|
|
|
Show Server Diagnostics
|
|
=======================
|
|
|
|
.. rest_method:: GET /servers/{server_id}/diagnostics
|
|
|
|
Shows basic usage data for a server.
|
|
|
|
Policy defaults enable only users with the administrative role. Cloud
|
|
providers can change these permissions through the ``policy.json``
|
|
file.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: unauthorized(401), forbidden(403), notfound(404), conflict(409), notimplemented(501)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
- server_id: server_id
|
|
|
|
Response
|
|
--------
|
|
|
|
The response format for diagnostics is backend hypervisor specific,
|
|
and not well defined. This should be considered a debug interface
|
|
only, and not relied upon by programmatic tools.
|
|
|
|
**Example Server diagnostics**
|
|
|
|
Below is an example of diagnostics for a libvirt based server instance.
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-server-diagnostics/server-diagnostics-get-resp.json
|
|
:language: javascript
|