nova/api-ref/source/os-simple-tenant-usage.inc
Sean Dague d929b9fc76 add tags to files for the content verification phase
This adds a set of tags in comments to the beginning of files so that
we can process them according to the documentation here:
https://wiki.openstack.org/wiki/NovaAPIRef

Part of bp:api-ref-in-rst

Change-Id: I17cf584dafb5bd969c12f51b7e7185d92365bf93
2016-04-20 16:21:58 -04:00

66 lines
1.6 KiB
ReStructuredText

.. -*- rst -*-
.. needs:method_verification
.. needs:parameter_verification
.. needs:example_verification
.. needs:body_verification
========================================
Usage reports (os-simple-tenant-usage)
========================================
Reports usage statistics on compute and storage resources.
List Tenant Usage For All Tenants
=================================
.. rest_method:: GET /v2.1/{tenant_id}/os-simple-tenant-usage
Lists usage information for all tenants.
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 Tenant Usage For All Tenants: JSON response**
.. literalinclude:: ../../doc/api_samples/os-simple-tenant-usage/simple-tenant-usage-get.json
:language: javascript
Show Usage Details For Tenant
=============================
.. rest_method:: GET /v2.1/{tenant_id}/os-simple-tenant-usage/{tenant_id}
Shows usage details for a tenant.
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 Show Usage Details For Tenant: JSON response**
.. literalinclude:: ../../doc/api_samples/os-simple-tenant-usage/simple-tenant-usage-get-specific.json
:language: javascript