cinder/api-ref/source/v2/capabilities-v2.inc
Nicholas Jones aa9cabdb42 Fix Block Storage API reference nesting
Modifies heading levels in .inc files to allow nested display in
table of contents. Table of contents depth has been changed to allow
this.

Change-Id: I3d8c9cf38a12272f0d32d3aa183d741277767535
2017-02-09 08:37:27 -06:00

51 lines
1.1 KiB
ReStructuredText

.. -*- rst -*-
Capabilities for storage back ends (capabilities)
=================================================
Shows capabilities for a storage back end.
Show back-end capabilities
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/{tenant_id}/capabilities/{hostname}
Shows capabilities for a storage back end on the host.
The ``hostname`` takes the form of ``hostname@volume_backend_name``.
Normal response codes: 200
Error response codes:
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- hostname: hostname
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- pool_name: pool_name
- description: description
- volume_backend_name: volume_backend_name
- namespace: namespace
- visibility: visibility
- driver_version: driver_version
- vendor_name: vendor_name
- properties: properties
- storage_protocol: storage_protocol
- replication_targets: replication_targets
- display_name: display_name
Response Example
----------------
.. literalinclude:: ./samples/backend-capabilities-response.json
:language: javascript