2018-08-16 14:31:56 +00:00
|
|
|
Controller notifications
|
|
|
|
|
========================
|
|
|
|
|
|
|
|
|
|
Controller notifications can be received from the controller, they can be used to get information
|
2018-11-20 09:21:32 +00:00
|
|
|
about computes and appliance.
|
2018-08-16 14:31:56 +00:00
|
|
|
|
|
|
|
|
Notification endpoints
|
|
|
|
|
**********************
|
|
|
|
|
|
|
|
|
|
Listen to the HTTP stream endpoint or to the WebSocket endpoint.
|
|
|
|
|
|
|
|
|
|
* :doc:`api/v2/controller/notification/notifications`
|
|
|
|
|
* :doc:`api/v2/controller/notification/notificationsws`
|
|
|
|
|
|
|
|
|
|
It is recommended to use the WebSocket endpoint.
|
|
|
|
|
|
|
|
|
|
Available notifications
|
|
|
|
|
***********************
|
|
|
|
|
|
|
|
|
|
.. contents::
|
|
|
|
|
:local:
|
|
|
|
|
|
|
|
|
|
ping
|
|
|
|
|
----
|
|
|
|
|
Keep-alive between client and controller. Also used to receive the current CPU and memory usage.
|
|
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/ping.json
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
compute.created
|
2018-11-20 06:04:27 +00:00
|
|
|
---------------
|
2018-08-16 14:31:56 +00:00
|
|
|
|
|
|
|
|
A compute has been created.
|
|
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/compute.created.json
|
|
|
|
|
|
|
|
|
|
compute.updated
|
2018-11-20 06:04:27 +00:00
|
|
|
---------------
|
2018-08-16 14:31:56 +00:00
|
|
|
|
|
|
|
|
A compute has been updated.
|
|
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/compute.updated.json
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
compute.deleted
|
|
|
|
|
---------------
|
|
|
|
|
|
|
|
|
|
A compute has been deleted.
|
|
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/compute.deleted.json
|
|
|
|
|
|
2018-11-20 06:04:27 +00:00
|
|
|
|
2024-01-12 02:21:34 +00:00
|
|
|
project.created
|
|
|
|
|
---------------
|
|
|
|
|
|
|
|
|
|
A project has been created.
|
|
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/project.created.json
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
project.updated
|
|
|
|
|
---------------
|
|
|
|
|
|
|
|
|
|
A project has been updated.
|
|
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/project.updated.json
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
project.closed
|
|
|
|
|
---------------
|
|
|
|
|
|
|
|
|
|
A project has been closed.
|
|
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/project.closed.json
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
project.deleted
|
|
|
|
|
---------------
|
|
|
|
|
|
|
|
|
|
A project has been deleted.
|
|
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/project.deleted.json
|
|
|
|
|
|
|
|
|
|
|
2018-11-28 09:12:57 +00:00
|
|
|
template.created
|
2018-11-20 06:04:27 +00:00
|
|
|
-----------------
|
|
|
|
|
|
2018-11-28 09:12:57 +00:00
|
|
|
A template has been created.
|
2018-11-20 06:04:27 +00:00
|
|
|
|
2018-11-28 09:12:57 +00:00
|
|
|
.. literalinclude:: api/notifications/template.created.json
|
2018-11-20 06:04:27 +00:00
|
|
|
|
|
|
|
|
|
2018-11-28 09:12:57 +00:00
|
|
|
template.updated
|
2018-11-20 06:04:27 +00:00
|
|
|
-----------------
|
|
|
|
|
|
2018-11-28 09:12:57 +00:00
|
|
|
A template has been updated.
|
2018-11-20 06:04:27 +00:00
|
|
|
|
2018-11-28 09:12:57 +00:00
|
|
|
.. literalinclude:: api/notifications/template.updated.json
|
2018-11-20 06:04:27 +00:00
|
|
|
|
|
|
|
|
|
2018-11-28 09:12:57 +00:00
|
|
|
template.deleted
|
2018-11-20 06:04:27 +00:00
|
|
|
-----------------
|
|
|
|
|
|
2018-11-28 09:12:57 +00:00
|
|
|
A template has been deleted.
|
2018-11-20 06:04:27 +00:00
|
|
|
|
2018-11-28 09:12:57 +00:00
|
|
|
.. literalinclude:: api/notifications/template.deleted.json
|
2018-11-20 06:04:27 +00:00
|
|
|
|
|
|
|
|
|
2018-08-16 14:31:56 +00:00
|
|
|
log.error
|
|
|
|
|
---------
|
|
|
|
|
|
|
|
|
|
Sends an error
|
|
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/log.error.json
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
log.warning
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
Sends a warning
|
|
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/log.warning.json
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
log.info
|
|
|
|
|
---------
|
|
|
|
|
|
|
|
|
|
Sends an information
|
|
|
|
|
|
|
|
|
|
.. literalinclude:: api/notifications/log.info.json
|
