2016-05-07 17:18:15 +02:00
|
|
|
|
.. -*- rst -*-
|
|
|
|
|
|
|
|
|
|
=======================================
|
|
|
|
|
Share export locations (since API v2.9)
|
|
|
|
|
=======================================
|
|
|
|
|
|
|
|
|
|
Set of APIs used for viewing export locations of shares.
|
|
|
|
|
|
2018-12-27 01:01:08 -08:00
|
|
|
|
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>`.
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
List export locations
|
|
|
|
|
=====================
|
|
|
|
|
|
2021-02-03 11:16:51 -08:00
|
|
|
|
.. rest_method:: GET /v2/shares/{share_id}/export_locations
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
2019-03-26 20:14:42 -07:00
|
|
|
|
.. versionadded:: 2.9
|
|
|
|
|
|
2016-05-07 17:18:15 +02:00
|
|
|
|
Lists all export locations for a share.
|
|
|
|
|
|
2018-03-22 18:38:36 +08:00
|
|
|
|
Response codes
|
|
|
|
|
--------------
|
|
|
|
|
|
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
|
|
|
|
|
|
- 200
|
|
|
|
|
|
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
|
|
|
|
|
|
- 400
|
|
|
|
|
- 401
|
|
|
|
|
- 403
|
|
|
|
|
- 404
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
|
|
Request
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
2018-12-07 19:55:30 +01:00
|
|
|
|
- project_id: project_id_path
|
2016-05-07 17:18:15 +02:00
|
|
|
|
- share_id: share_id
|
|
|
|
|
|
|
|
|
|
Response parameters
|
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
2016-12-27 12:57:00 +07:00
|
|
|
|
- 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
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
|
|
Response example
|
|
|
|
|
----------------
|
|
|
|
|
|
|
|
|
|
.. literalinclude:: samples/export-location-list-response.json
|
|
|
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Show single export location
|
|
|
|
|
===========================
|
|
|
|
|
|
2021-02-03 11:16:51 -08:00
|
|
|
|
.. rest_method:: GET /v2/shares/{share_id}/export_locations/{export_location_id}
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
2019-03-26 20:14:42 -07:00
|
|
|
|
.. versionadded:: 2.9
|
|
|
|
|
|
2016-05-07 17:18:15 +02:00
|
|
|
|
Show details of an export location belonging to a share.
|
|
|
|
|
|
2018-03-22 18:38:36 +08:00
|
|
|
|
Response codes
|
|
|
|
|
--------------
|
|
|
|
|
|
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
|
|
|
|
|
|
- 200
|
|
|
|
|
|
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
|
|
|
|
|
|
- 400
|
|
|
|
|
- 401
|
|
|
|
|
- 403
|
|
|
|
|
- 404
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
|
|
Request
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
2018-12-07 19:55:30 +01:00
|
|
|
|
- project_id: project_id_path
|
2016-05-07 17:18:15 +02:00
|
|
|
|
- share_id: share_id
|
2017-11-17 10:28:18 +08:00
|
|
|
|
- export_location_id: export_location_id_path
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
|
|
Response parameters
|
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
2016-12-27 12:57:00 +07:00
|
|
|
|
- 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
|
2019-03-28 14:56:08 -07:00
|
|
|
|
- created_at: created_at
|
|
|
|
|
- updated_at: updated_at
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
|
|
Response example
|
|
|
|
|
----------------
|
|
|
|
|
|
|
|
|
|
.. literalinclude:: samples/export-location-show-response.json
|
|
|
|
|
:language: javascript
|