deb-manila/api-ref/source/services.inc
Ha Van Tu 5e6eef7a60 [api-ref] Refactor limits and services API
This patch refactors limits and services API to make it clear to
understand and maintain.

Change-Id: I0e214f59e193f861e4959dfef951854bea530b7b
2016-09-15 11:02:08 +07:00

141 lines
2.9 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``.
List services
=============
.. rest_method:: GET /v2/{tenant_id}/services?host={host}&binary={binary}&zone={zone}&state={state}&status={status}
Lists all services optionally filtered with the specified search options.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_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: service_updated_at
Response example
----------------
.. literalinclude:: samples/services-list-response.json
:language: javascript
Enable service
==============
.. rest_method:: PUT /v2/{tenant_id}/services/enable
Enables a service.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_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
Response example
----------------
.. literalinclude:: samples/service-enable-response.json
:language: javascript
Disable service
===============
.. rest_method:: PUT /v2/{tenant_id}/services/disable
Disables a service.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- binary: service_disable_binary_request
- host: service_disable_host_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
Response example
----------------
.. literalinclude:: samples/service-disable-response.json
:language: javascript