53918308c8
Users of replicated shares expect to see primary
export locations when viewing information regarding
the share. Because we collate exports of all replicas
within the export locations APIs, it becomes hard for
users to discern which exports belong to the primary
share. For secondary replicas, users would also need
additional information (availability zone, state of the
replication) to work with.
Introduce micro-version 2.47 from which the export locations
API (GET /v2/{tenant_id}/shares/{share_id}/export_locations)
no longer provides export locations of non-active share
replicas. A new API has been introduced to provide export
location details for share replicas, both active and non-active.
(GET /v2/{tenant_id}/share-replicas/{share_replica_id}/export-locations)
The new API provides the replica's state and availability zone
in addition to the export location information.
APIImpact
Implements: bp export-locations-az
Change-Id: I0a1d9dd00b4c13ac01988e30ca2b7d7ce4a747d1
110 lines
2.3 KiB
ReStructuredText
110 lines
2.3 KiB
ReStructuredText
.. -*- rst -*-
|
||
|
||
=======================================
|
||
Share export locations (since API v2.9)
|
||
=======================================
|
||
|
||
Set of APIs used for viewing export locations of shares.
|
||
|
||
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>`.
|
||
|
||
|
||
List export locations
|
||
=====================
|
||
|
||
.. rest_method:: GET /v2/{tenant_id}/shares/{share_id}/export_locations
|
||
|
||
Lists all export locations for a share.
|
||
|
||
Response codes
|
||
--------------
|
||
|
||
.. rest_status_code:: success status.yaml
|
||
|
||
- 200
|
||
|
||
.. rest_status_code:: error status.yaml
|
||
|
||
- 400
|
||
- 401
|
||
- 403
|
||
- 404
|
||
|
||
Request
|
||
-------
|
||
|
||
.. rest_parameters:: parameters.yaml
|
||
|
||
- share_id: share_id
|
||
- tenant_id: tenant_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
|
||
|
||
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.
|
||
|
||
Response codes
|
||
--------------
|
||
|
||
.. rest_status_code:: success status.yaml
|
||
|
||
- 200
|
||
|
||
.. rest_status_code:: error status.yaml
|
||
|
||
- 400
|
||
- 401
|
||
- 403
|
||
- 404
|
||
|
||
Request
|
||
-------
|
||
|
||
.. rest_parameters:: parameters.yaml
|
||
|
||
- share_id: share_id
|
||
- tenant_id: tenant_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
|
||
- created_at: export_location_created_at
|
||
- updated_at: export_location_updated_at
|
||
|
||
Response example
|
||
----------------
|
||
|
||
.. literalinclude:: samples/export-location-show-response.json
|
||
:language: javascript
|