manila/api-ref/source/share-replica-export-locations.inc
Goutham Pacha Ravi de29398128 [doc] remove project_id from api endpoints
As of API version 2.60, a project_id is no
longer needed in the API URLs.

Fix the docs to indicate that.

Also fix up a few quota parameters that use
project_id in a different place in the API path.

Change-Id: I24b32c8521805a7d67d512d36d644c0f07c532ea
Implements: bp remove-project-id-from-urls
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2021-02-09 21:59:07 -08:00

111 lines
2.3 KiB
ReStructuredText

.. -*- rst -*-
.. _share_replica_export_locations:
================================================
Share replica export locations (since API v2.47)
================================================
Set of APIs used to view export locations of share replicas.
List export locations
=====================
.. rest_method:: GET /v2/share-replicas/{share_replica_id}/export-locations
.. versionadded:: 2.47
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_replica_id: share_replica_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_replicas
- availability_zone: export_location_availability_zone
- replica_state: share_replica_replica_state
Response example
----------------
.. literalinclude:: samples/share-replica-export-location-list-response.json
:language: javascript
Show single export location
===========================
.. rest_method:: GET /v2/share-replicas/{share_replica_id}/export-locations/{export-location-id}
.. versionadded:: 2.47
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_replica_id: share_replica_id_path
- 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_replicas
- availability_zone: export_location_availability_zone
- replica_state: share_replica_replica_state
- created_at: created_at
- updated_at: updated_at
Response example
----------------
.. literalinclude:: samples/share-replica-export-location-show-response.json
:language: javascript