Echtzeit-Ereignisse
Lassen Sie sich sofort über Änderungen informieren, statt regelmäßig abzufragen.
GET /v1/events ist ein Server-Sent-Events-Stream mit
Änderungen an den Ressourcen, die Sie sehen dürfen. Die Console nutzt ihn, um jede Seite live zu aktualisieren; auch Ihre
eigenen Tools können ihn verwenden. Er funktioniert mit einem API-Token (Sie erhalten die Änderungen im Projekt des
Tokens) oder mit einer Console-Sitzung (alle Projekte und Organisationen, denen Sie angehören).
curl -N -H "Authorization: Bearer $ODX_TOKEN" https://api.odinex.cloud/v1/eventsretry: 3000
event: ready
data: {}
event: change
data: {"type":"action","id":4211,"op":"insert","project_id":7,"org_id":3}
event: change
data: {"type":"server","id":42,"op":"update","project_id":7,"org_id":3}
: pingEreignisse
| Ereignis | Bedeutung |
|---|---|
ready | Verbunden. Änderungen, die während der Trennung stattfanden, wurden nicht gesendet: Laden Sie neu, was Sie anzeigen. |
change | Etwas hat sich geändert. data benennt es: type, id, op (insert, update, delete) sowie project_id / org_id. |
resync | Ihr Client ist zurückgefallen, und einige Ereignisse wurden verworfen: Laden Sie alles neu. |
type ist einer der Werte server, volume, floating_ip, elastic_ip, primary_ip, network, nat_gateway, firewall,
load_balancer, image, placement_group, ssh_key, action, stack, api_token, project, ticket, wallet,
organization, membership, incident oder user.
Ereignisse sagen Ihnen, was sich geändert hat, nicht die neuen Daten: Lesen Sie die Ressource über die API, damit Sie
stets den aktuellen Zustand mit Ihren üblichen Berechtigungen erhalten. Eine Änderung an der Netzwerkanbindung eines
Servers kommt als server-Änderung an; der Fortschritt einer Aktion kommt als action-Update an,
sodass Sie eine Aktion ohne regelmäßiges Abfragen verfolgen können.
Hinweise
- Alle 20 Sekunden wird eine Kommentarzeile (
: ping) gesendet, damit Proxys die Verbindung offen halten. EventSourceim Browser verbindet sich selbstständig neu; andere Clients sollten sich nachretryMillisekunden neu verbinden.- Pro Benutzer oder Token dürfen höchstens 10 Streams gleichzeitig geöffnet sein.
- Ereignisse sind Benachrichtigungen ohne Zustellgarantie (Best Effort). Betrachten Sie die API als maßgebliche Quelle und laden Sie nach
readyundresyncneu.