heat/api-ref/source/v1/service-status.inc
Jay Dobies 4170566618 Migrate API documentations into the Heat tree
For more information, see:
http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html

This is the initial port from api-site. The includes in
source/v1/index.rst are alphabetized, but we may want to revisit that
and reorder them according to importance.

Change-Id: I6f578107e17d3a97e667f645a05493da12ae2048
Implements: blueprint api-doc-migration
2016-05-04 15:46:28 -04:00

68 lines
1.2 KiB
ReStructuredText

.. -*- rst -*-
==============
Manage service
==============
Show orchestration engine status
================================
.. rest_method:: GET /v1/{tenant_id}/services
Enables administrative users to view details for all orchestration engines.
Orchestration engine details include ``engine_id``, topic name,
last updated time, health status, and host name.
Troubleshooting
- A ``503`` error code indicates that the heat engines are not
operational. Run the heat-manage service list command or contact
your cloud provider to determine why the heat engines are not
operational.
Normal response codes: 200
Error response codes:403,503,
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- status: status
- binary: binary
- report_interval: report_interval
- created_at: created_at
- hostname: hostname
- updated_at: updated_at
- topic: topic
- services: services
- deleted_at: deleted_at
- id: id
Response Example
----------------
.. literalinclude:: samples/services-list-response.json
:language: javascript