manila/api-ref/source/share-instance-export-locations.inc
junboli acf8c99e9b Use rest_status_code for api-ref response codes
Rather than our freeform way of listing response codes in our
api-ref, we should be using the os-api-ref extension option to
get nicely formatted response code listings.

https://docs.openstack.org/os-api-ref/latest/usage.html#rest-status-code

Change-Id: Ibafafa2f9c3b301b5cdd9b1cb3b8b6d678faa731
2018-03-24 01:07:16 +00:00

109 lines
2.3 KiB
ReStructuredText

.. -*- rst -*-
================================================
Share instance export locations (since API v2.9)
================================================
Set of APIs used to view export locations of share instances.
By default, these APIs are admin-only. Use the ``policy.json`` file
to grant permissions for these actions to other roles.
Lists all export locations for a share instance.
Show details of an export location belonging to a share instance.
List export locations
=====================
.. rest_method:: GET /v2/{tenant_id}/share_instances/{share_instance_id}/export_locations
Response codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- share_instance_id: share_instance_id
Response parameters
-------------------
.. rest_parameters:: parameters.yaml
- id: export_location_id
- share_instance_id: export_location_share_instance_id
- path: export_location_path
- is_admin_only: export_location_is_admin_only
- preferred: export_location_preferred
Response example
----------------
.. literalinclude:: samples/export-location-list-response.json
:language: javascript
Show single export location
===========================
.. rest_method:: GET /v2/{tenant_id}/share_instances/{share_instance_id}/export_locations/{export_location_id}
Response codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- share_instance_id: share_instance_id
- export_location_id: export_location_id_path
Response parameters
-------------------
.. rest_parameters:: parameters.yaml
- id: export_location_id
- share_instance_id: export_location_share_instance_id
- path: export_location_path
- is_admin_only: export_location_is_admin_only
- preferred: export_location_preferred
- created_at: export_location_created_at
- updated_at: export_location_updated_at
Response example
----------------
.. literalinclude:: samples/export-location-show-response.json
:language: javascript