nova/api-ref/source/os-instance-usage-audit-log.inc
Sean Dague 9526462326 move sphinx h3 to '-' instead of '^'
In the sphinx document h3 is supposed to be '-' not '^':

=, for sections
-, for subsections
^, for subsubsections

We have to enforce consistency here because we're processing included
files which all have to agree, otherwise it's a sphinx error.

Part of bp:api-ref-in-rst

Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
2016-04-15 07:43:06 -04:00

70 lines
1.7 KiB
ReStructuredText

.. -*- rst -*-
========================================================
Instance usage audit log (os-instance-usage-audit-log)
========================================================
Administrator only. Monitors task logs.
List Usage Audits For An Instance
=================================
.. rest_method:: GET /v2.1/{tenant_id}/os-instance_usage_audit_log
Lists usage audits for an instance.
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
Response
--------
**Example List Usage Audits For An Instance: JSON request**
.. literalinclude:: ../../doc/api_samples/os-instance-usage-audit-log/usage-audits-list-resp.json
:language: javascript
List Usage Audits Before Specified Time
=======================================
.. rest_method:: GET /v2.1/{tenant_id}/os-instance_usage_audit_log/{before_timestamp}
Lists usage audits that occurred before a specified time.
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
Query Parameters
~~~~~~~~~~~~~~~~
.. rest_parameters:: parameters.yaml
- before_timestamp: before_timestamp
Response
--------
**Example List Usage Audits Before Specified Time: JSON request**
.. literalinclude:: ../../doc/api_samples/os-instance-usage-audit-log/usage-audits-log-list-resp.json
:language: javascript