cinder/api-ref/source/v3/capabilities-v3.inc
yfzhao 88aa1bcabb Add two response parameters in the api-ref of getting capabilities
Add "display_name" and "replication_targets" to the response parameters
in the api-ref of getting capabilities.

Change-Id: Id1776641ea9938d024906707fec2e21404668ff7
Closes-bug: #1674237
2017-03-25 12:25:07 +08:00

50 lines
1.1 KiB
ReStructuredText

.. -*- rst -*-
Capabilities for storage back ends (capabilities)
=================================================
Shows capabilities for a storage back end.
Show all back-end capabilities
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v3/{project_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
- project_id: project_id_path
- 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