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.
|
|
|
|
|
|
|
|
|
|
|
|
By default, these APIs are admin-only. Use the ``policy.json`` file
|
|
|
|
|
|
to grant permissions for these actions to other roles.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
List export locations
|
|
|
|
|
|
=====================
|
|
|
|
|
|
|
|
|
|
|
|
.. rest_method:: GET /v2/{tenant_id}/shares/{share_id}/export_locations
|
|
|
|
|
|
|
|
|
|
|
|
Lists all export locations for a share.
|
|
|
|
|
|
|
|
|
|
|
|
Normal response codes: 200
|
|
|
|
|
|
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
|
|
|
|
itemNotFound(404)
|
|
|
|
|
|
|
|
|
|
|
|
Request
|
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
|
|
|
|
|
|
- share_id: share_id
|
2016-12-27 12:57:00 +07:00
|
|
|
|
- tenant_id: tenant_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
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
|
|
|
Response example
|
|
|
|
|
|
----------------
|
|
|
|
|
|
|
|
|
|
|
|
.. literalinclude:: samples/export-location-list-response.json
|
|
|
|
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Show single export location
|
|
|
|
|
|
===========================
|
|
|
|
|
|
|
|
|
|
|
|
.. rest_method:: GET /v2/{tenant_id}/shares/{share_id}/export_locations/{export_location_id}
|
|
|
|
|
|
|
|
|
|
|
|
Show details of an export location belonging to a share.
|
|
|
|
|
|
|
|
|
|
|
|
Normal response codes: 200
|
|
|
|
|
|
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
|
|
|
|
itemNotFound(404)
|
|
|
|
|
|
|
|
|
|
|
|
Request
|
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
|
|
|
|
|
|
- share_id: share_id
|
2016-12-27 12:57:00 +07:00
|
|
|
|
- tenant_id: tenant_id_path
|
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
|
|
|
|
|
|
- created_at: export_location_created_at
|
|
|
|
|
|
- updated_at: export_location_updated_at
|
2016-05-07 17:18:15 +02:00
|
|
|
|
|
|
|
|
|
|
Response example
|
|
|
|
|
|
----------------
|
|
|
|
|
|
|
|
|
|
|
|
.. literalinclude:: samples/export-location-show-response.json
|
|
|
|
|
|
:language: javascript
|
