77f17259bb
This change updates the documentation for the ensure shares APIs. The side effects such as the shares status updates and the new field will be added to the admin documentation as well. Change-Id: I3c550b5f77356f89a8c3bdad9fb5c67f1fe8ff4a Signed-off-by: Carlos Eduardo <ces.eduardo98@gmail.com>
224 lines
4.3 KiB
ReStructuredText
224 lines
4.3 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
Services
|
|
========
|
|
|
|
These APIs help in interacting with the Shared File Systems services,
|
|
``manila-scheduler``, ``manila-share`` and ``manila-data``.
|
|
|
|
.. important::
|
|
|
|
For API versions 2.6 and prior, replace ``services`` in the URLs
|
|
with ``os-services``.
|
|
|
|
.. note::
|
|
Starting from API version 2.83, ``disabled`` field will be replaced
|
|
by ``status`` field in response of enable or disable service request.
|
|
Re-enabling a disabled service will automatically clear ``disable reason``.
|
|
|
|
|
|
List services
|
|
~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: GET /v2/services?host={host}&binary={binary}&zone={zone}&state={state}&status={status}
|
|
|
|
Lists all services optionally filtered with the specified search options.
|
|
|
|
Response codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 400
|
|
- 401
|
|
- 403
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- project_id: project_id_path
|
|
- host: service_host_query
|
|
- binary: service_binary_query
|
|
- zone: service_zone_query
|
|
- state: service_state_query
|
|
- status: service_status_query
|
|
|
|
Response parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- services: services
|
|
- id: service_id_response
|
|
- status: service_status_response
|
|
- binary: service_binary_response
|
|
- zone: service_zone_response
|
|
- host: service_host_response
|
|
- state: service_state_response
|
|
- updated_at: updated_at
|
|
- disabled_reason: service_disable_reason_response
|
|
- ensuring: service_ensuring_response
|
|
|
|
Response example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/services-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
Enable service
|
|
~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: PUT /v2/services/enable
|
|
|
|
Enables a service.
|
|
|
|
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
|
|
- binary: service_enable_binary_request
|
|
- host: service_enable_host_request
|
|
|
|
Request example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/service-enable-request.json
|
|
:language: javascript
|
|
|
|
Response parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- host: service_enable_host_response
|
|
- binary: service_binary_response
|
|
- disabled: service_disabled_response
|
|
- status: service_status_new_response
|
|
- disabled_reason: service_disable_reason_response
|
|
|
|
Response example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/service-enable-response.json
|
|
:language: javascript
|
|
|
|
|
|
Disable service
|
|
~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: PUT /v2/services/disable
|
|
|
|
Disables a service.
|
|
|
|
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
|
|
- binary: service_disable_binary_request
|
|
- host: service_disable_host_request
|
|
- disabled_reason: service_disable_reason_request
|
|
|
|
Request example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/service-disable-request.json
|
|
:language: javascript
|
|
|
|
Response parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- host: service_disable_host_response
|
|
- binary: service_disable_binary_response
|
|
- disabled: service_disabled_response
|
|
- status: service_status_new_response
|
|
- disabled_reason: service_disable_reason_response
|
|
|
|
Response example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/service-disable-response.json
|
|
:language: javascript
|
|
|
|
|
|
Ensure shares (Since API Version 2.86)
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. rest_method:: POST /v2/services/ensure-shares
|
|
|
|
Starts the ensure shares procedure for a manila-share binary.
|
|
|
|
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
|
|
- host: service_ensure_shares_host_request
|
|
|
|
Request example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/service-ensure-shares-request.json
|
|
:language: javascript
|
|
|
|
Response parameters
|
|
-------------------
|
|
|
|
There is no body content for the response.
|