3e86e3deac
The API Documentation team has requires [1] that projects maintain their api-reference in-tree and build it to the developer.openstack.org website. This version of the API reference uses os-api-ref and compiles API documentation close to that of the OpenStack compute service (nova). Co-Authored-By: Goutham Pacha Ravi <gouthamr@netapp.com> [0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html Implements: bp move-manila-api-reference-in-tree Change-Id: I67bb3354162d6e0e00fa2788edde864cc14920ee
88 lines
1.9 KiB
ReStructuredText
88 lines
1.9 KiB
ReStructuredText
.. -*- 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
|
||
- tenant_id: tenant_id_1
|
||
|
||
Response parameters
|
||
-------------------
|
||
|
||
.. rest_parameters:: parameters.yaml
|
||
|
||
- id: id_5
|
||
- share_instance_id: share_instance_id_1
|
||
- path: path
|
||
- is_admin_only: is_admin_only
|
||
- preferred: preferred
|
||
|
||
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
|
||
- tenant_id: tenant_id_1
|
||
- export_location_id: export_location_id
|
||
|
||
Response parameters
|
||
-------------------
|
||
|
||
.. rest_parameters:: parameters.yaml
|
||
|
||
- id: id_5
|
||
- share_instance_id: share_instance_id_1
|
||
- path: path
|
||
- is_admin_only: is_admin_only
|
||
- preferred: preferred
|
||
- created_at: created_at_5
|
||
- updated_at: updated_at_2
|
||
|
||
Response example
|
||
----------------
|
||
|
||
.. literalinclude:: samples/export-location-show-response.json
|
||
:language: javascript
|