cinder/api-ref/source/v2/capabilities-v2.inc
wangxiyuan a3602906a3 Fix the api-ref CI failure
Our Api-ref CI job failed due to the change[1] in os-api-ref.

This patch fixed the issue.

[1]: I8686006339b82ed5465dd8e4d3a8b15f85ee897c

Change-Id: I00458bef8729e9ff877b4e38563f5d133de47cf5
2017-01-25 14:04:45 +00:00

52 lines
1.2 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