7fa8165180
Current capabilities api-ref explains that the API takes
{hostname}, but this is not accurate.
Actually this api takes hostname@volume_backend_name format.
To avoid confusion, this explanation should be updated.
Change-Id: I0d9e9925a1b011f49cefc9867f617e8b51ec7437
52 lines
1.1 KiB
ReStructuredText
52 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/{host}
|
|
|
|
Shows capabilities for a storage back end on the host.
|
|
The ``host`` 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
|