[doc][api-ref] Clarify manage/unmanage APIs
Clarify the usage of these APIs wrt DHSS=True/False drivers. Partial-Bug: #1818758 Partial-Bug: #1760644 Change-Id: I0fb239a44dee5b2c8da1d469ae761e780d14b4b2
This commit is contained in:
parent
c507a3b272
commit
5cd643785d
|
@ -1,29 +1,30 @@
|
||||||
.. -*- rst -*-
|
.. -*- rst -*-
|
||||||
|
|
||||||
==========================
|
=======================================
|
||||||
Manage and unmanage shares
|
Manage and unmanage shares (DEPRECATED)
|
||||||
==========================
|
=======================================
|
||||||
|
|
||||||
Configures Shared File Systems to manage or unmanage a share.
|
Allows bringing shared file systems under service management.
|
||||||
|
|
||||||
|
|
||||||
Manage share
|
Manage share (DEPRECATED)
|
||||||
============
|
=========================
|
||||||
|
|
||||||
|
.. warning::
|
||||||
|
|
||||||
|
This API is deprecated starting with microversion 2.7 and requests to
|
||||||
|
this API will fail with a 404 starting from microversion 2.7. Use
|
||||||
|
`Share Manage API <#manage-share-since-api-v2-7>`_ instead of this API
|
||||||
|
from version 2.7.
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/os-share-manage
|
.. rest_method:: POST /v2/{tenant_id}/os-share-manage
|
||||||
|
|
||||||
**Minimum Supported API Version**: 1.0, 2.0
|
|
||||||
**Last supported API Version**: 2.6
|
|
||||||
|
|
||||||
Use this API to bring a share under the management of the Shared File
|
Use this API to bring a share under the management of the Shared File
|
||||||
Systems service.
|
Systems service.
|
||||||
|
|
||||||
Administrator only. Use the ``policy.json`` file to grant permissions for this
|
Administrator only. Use the ``policy.json`` file to grant permissions for this
|
||||||
action to other roles.
|
action to other roles.
|
||||||
|
|
||||||
This API was removed in API version 2.7; please see share actions for the
|
|
||||||
new version of the API to utilize this feature.
|
|
||||||
|
|
||||||
Response codes
|
Response codes
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
|
@ -101,26 +102,32 @@ Response example
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
Unmanage share
|
Unmanage share (DEPRECATED)
|
||||||
==============
|
===========================
|
||||||
|
|
||||||
|
.. warning::
|
||||||
|
|
||||||
|
This API is deprecated starting with microversion 2.7 and requests to
|
||||||
|
this API will fail with a 404 starting from microversion 2.7. Use
|
||||||
|
`Share Unmanage API <#unmanage-share-since-api-v2-7>`_ instead of this
|
||||||
|
API from version 2.7.
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/os-share-unmanage/{share_id}/unmanage
|
.. rest_method:: POST /v2/{tenant_id}/os-share-unmanage/{share_id}/unmanage
|
||||||
|
|
||||||
**Minimum Supported API Version**: 1.0, 2.0
|
|
||||||
**Last supported API Version**: 2.6
|
|
||||||
|
|
||||||
Use this API to remove a share from the management of the Shared File
|
Use this API to remove a share from the management of the Shared File
|
||||||
Systems service.
|
Systems service without deleting the share.
|
||||||
|
|
||||||
Administrator only. Use the ``policy.json`` file to grant permissions for this
|
Administrator only. Use the ``policy.json`` file to grant permissions for this
|
||||||
action to other roles.
|
action to other roles.
|
||||||
|
|
||||||
Share unmanage operation is not supported for shares that are created on top
|
|
||||||
of share servers (created with share networks). You should remove any
|
|
||||||
snapshots and share replicas before attempting to unmanage a share.
|
|
||||||
|
|
||||||
This API was removed in API version 2.7; please see share actions for the
|
Preconditions:
|
||||||
new version of the API to utilize this feature.
|
|
||||||
|
- This API does not support unmanaging shares that are created on top
|
||||||
|
of share servers (i.e. created with share networks).
|
||||||
|
- You should remove any snapshots and share replicas before attempting to
|
||||||
|
unmanage a share.
|
||||||
|
|
||||||
|
|
||||||
Response codes
|
Response codes
|
||||||
--------------
|
--------------
|
||||||
|
@ -144,3 +151,9 @@ Request
|
||||||
|
|
||||||
- tenant_id: tenant_id_path
|
- tenant_id: tenant_id_path
|
||||||
- share_id: share_id
|
- share_id: share_id
|
||||||
|
|
||||||
|
|
||||||
|
Response parameters
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
There is no body content for the response.
|
||||||
|
|
|
@ -391,12 +391,30 @@ Request example
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
Unmanage share
|
Unmanage share (since API v2.7)
|
||||||
==============
|
===============================
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/shares/{share_id}/action
|
.. rest_method:: POST /v2/{tenant_id}/shares/{share_id}/action
|
||||||
|
|
||||||
This API is available in versions later than or equal to 2.7
|
.. versionadded:: 2.7
|
||||||
|
|
||||||
|
|
||||||
|
Use this API to remove a share from the management of the Shared File
|
||||||
|
Systems service without deleting the share.
|
||||||
|
|
||||||
|
Administrator only. Use the ``policy.json`` file to grant permissions for this
|
||||||
|
action to other roles.
|
||||||
|
|
||||||
|
|
||||||
|
Preconditions:
|
||||||
|
|
||||||
|
- You should remove any snapshots and share replicas before attempting to
|
||||||
|
unmanage a share.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Unmanaging shares that are created on top of share servers (i.e. created
|
||||||
|
with share networks) is not supported prior to API version 2.49.
|
||||||
|
|
||||||
Response codes
|
Response codes
|
||||||
--------------
|
--------------
|
||||||
|
@ -429,6 +447,11 @@ Request example
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
Response parameters
|
||||||
|
-------------------
|
||||||
|
There is no body content for the response.
|
||||||
|
|
||||||
|
|
||||||
Revert share to snapshot
|
Revert share to snapshot
|
||||||
========================
|
========================
|
||||||
|
|
||||||
|
|
|
@ -401,13 +401,19 @@ Response example
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
Manage share
|
Manage share (since API v2.7)
|
||||||
============
|
=============================
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/shares/manage
|
.. rest_method:: POST /v2/{tenant_id}/shares/manage
|
||||||
|
|
||||||
|
.. versionadded:: 2.7
|
||||||
|
|
||||||
|
Use this API to bring a share under the management of the Shared File
|
||||||
|
Systems service.
|
||||||
|
|
||||||
|
Administrator only. Use the ``policy.json`` file to grant permissions for this
|
||||||
|
action to other roles.
|
||||||
|
|
||||||
Configures Shared File Systems to manage a share.
|
|
||||||
This API is available for API versions later than or equal to 2.7
|
|
||||||
|
|
||||||
Response codes
|
Response codes
|
||||||
--------------
|
--------------
|
||||||
|
|
|
@ -249,12 +249,20 @@ Response example
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
Manage share snapshot
|
Manage share snapshot (since API v2.12)
|
||||||
=====================
|
=======================================
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/snapshots/manage
|
.. rest_method:: POST /v2/{tenant_id}/snapshots/manage
|
||||||
|
|
||||||
(Since API v2.12) Configures Shared File Systems to manage a share snapshot.
|
.. versionadded:: 2.12
|
||||||
|
|
||||||
|
Configures Shared File Systems to manage a share snapshot.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Managing snapshots of shares that are created on top of share servers
|
||||||
|
(i.e. created with share networks) is not supported prior to API version
|
||||||
|
2.49.
|
||||||
|
|
||||||
Response codes
|
Response codes
|
||||||
--------------
|
--------------
|
||||||
|
@ -314,12 +322,20 @@ Response example
|
||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
Unmanage share snapshot
|
Unmanage share snapshot (since API v2.12)
|
||||||
=======================
|
=========================================
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/snapshots/{snapshot_id}/action
|
.. rest_method:: POST /v2/{tenant_id}/snapshots/{snapshot_id}/action
|
||||||
|
|
||||||
(Since API v2.12) Configures Shared File Systems to stop managing a share snapshot.
|
.. versionadded:: 2.12
|
||||||
|
|
||||||
|
Configures Shared File Systems to stop managing a share snapshot.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Unmanaging snapshots of shares that are created on top of share servers
|
||||||
|
(i.e. created with share networks) is not supported prior to API version
|
||||||
|
2.49.
|
||||||
|
|
||||||
Response codes
|
Response codes
|
||||||
--------------
|
--------------
|
||||||
|
|
Loading…
Reference in New Issue