46 lines
1.2 KiB
ReStructuredText
46 lines
1.2 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_path
|
|
|
|
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 instance. The unit of the return
|
|
value is hypervisor specific, but in this case the unit of vnet1_rx* and
|
|
vnet1_tx* is octets.
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-server-diagnostics/server-diagnostics-get-resp.json
|
|
:language: javascript
|