manila/api-ref/source/share-export-locations.inc

114 lines
2.3 KiB
ReStructuredText
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

.. -*- rst -*-
=======================================
Share export locations (since API v2.9)
=======================================
Set of APIs used for viewing export locations of shares.
These APIs allow retrieval of export locations belonging to non-active share
replicas until API version 2.46. In and beyond API version 2.47, export
locations of non-active share replicas can only be retrieved using the
:ref:`Share Replica Export Locations APIs <share_replica_export_locations>`.
List export locations
=====================
.. rest_method:: GET /v2/{project_id}/shares/{share_id}/export_locations
.. versionadded:: 2.9
Lists all export locations for a share.
Response codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
Request
-------
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- share_id: share_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/{project_id}/shares/{share_id}/export_locations/{export_location_id}
.. versionadded:: 2.9
Show details of an export location belonging to a share.
Response codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
Request
-------
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- share_id: share_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: created_at
- updated_at: updated_at
Response example
----------------
.. literalinclude:: samples/export-location-show-response.json
:language: javascript