manila/api-ref/source/share-access-rules.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

123 lines
2.2 KiB
ReStructuredText

.. -*- rst -*-
.. _get-access-rules-after-2-45:
====================================
Share access rules (since API v2.45)
====================================
Retrieve details about access rules
Describe share access rule
==========================
.. rest_method:: GET /v2/share-access-rules/{access_id}
.. versionadded:: 2.45
Retrieve details about a specified access rule.
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
- access_id: access_id_path
Response parameters
-------------------
.. rest_parameters:: parameters.yaml
- share_id: access_share_id
- created_at: created_at
- updated_at: updated_at
- access_type: access_type
- access_to: access_to
- access_key: access_key
- state: state
- access_level: access_level
- id: access_rule_id
- access_metadata: access_metadata
Response example
----------------
.. literalinclude:: samples/share-access-rules-show-response.json
:language: javascript
List share access rules
=======================
.. rest_method:: GET /v2/share-access-rules?share_id={share-id}
.. versionadded:: 2.45
Lists the share access rules on a share.
.. note::
This API replaces the older :ref:`List share access rules
<get-access-rules-before-2-45>` API from version 2.45.
Response codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 409
Request
-------
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- share_id: share_id_access_rules_query
- metadata: metadata
Response parameters
-------------------
.. rest_parameters:: parameters.yaml
- metadata: access_metadata
- access_type: access_type
- access_key: access_key
- access_to: access_to
- access_level: access_level
- state: state
- access_list: access_list
- id: access_rule_id
- created_at: created_at
- updated_at: updated_at
Response example
----------------
.. literalinclude:: samples/share-access-rules-list-response.json
:language: javascript