d7140ffe09
Nowadays "project" and "project_id" are used instead of "tenant" in the OpenStack world. See [1] and [2]. - Replace "tenant_id" in the API paths to "project_id" - For most manila resources, the "project_id" in an API response body refers to the project that owns the resource. So, create a unified parameter and share that across the APIs. - Fix path variable names, and their order - Fix usage of "UUID" to refer to project and user IDs - Fix query parameters [1] https://docs.openstack.org/operations-guide/ops-projects-users.html [2] https://developer.openstack.org/api-ref/identity/v3/index.html#projects Partial-Bug: #1760644 Co-Authored-By: Goutham Pacha Ravi <gouthampravi@gmail.com> Change-Id: I64e4ef8ad258d07c7d80d11a4d015c4b82156722
112 lines
2.3 KiB
ReStructuredText
112 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/{project_id}/share_instances/{share_instance_id}/export_locations
|
|
|
|
.. versionadded:: 2.9
|
|
|
|
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_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/{project_id}/share_instances/{share_instance_id}/export_locations/{export_location_id}
|
|
|
|
.. versionadded:: 2.9
|
|
|
|
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_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
|