better/compute
API

events

A tenant's CloudEvents-style events, read from the transactional outbox that every change writes to in its own transaction. Pages follow the outbox's `txid:seq` position, so no event ever appears behind a cursor already handed out. See [Events](/docs/guides/events).

A tenant's CloudEvents-style events, read from the transactional outbox that every change writes to in its own transaction. Pages follow the outbox's txid:seq position, so no event ever appears behind a cursor already handed out. See Events.

All 1 methods are served by this release.

MethodKindAuthorizationPhaseStatus
listreadcompute:events:read @ compute-tenantv0.1registered

list

POST /api/compute/events/list

Returns a page of the tenant's committed events after cursor, oldest first, optionally only those whose type starts with type (for example node. or reservation.).

  • Decided with compute:events:read on compute-tenant/{tenantId}.

  • The cursor is an event's sequence in the form txid:seq; without one the page starts at the oldest event still in the outbox.

  • Only events whose transaction is older than every transaction still open are returned, so a later page never gains an event that sorts before its cursor.

  • limit is at most 500 (100 by default).

  • Kind: read

  • Authorization: compute:events:read @ compute-tenant

  • Module: server

  • Phase: v0.1 (registered)

Input

FieldTypeRequiredConstraints
tenantIdstringyesat most 128 characters; matches ^[A-Za-z0-9._:-]{1,128}$
typestringat most 64 characters; matches ^[a-z][a-z0-9.-]{0,63}$
limitinteger1-500; default 100
cursorstringat most 41 characters; matches ^\d{1,20}:\d{1,20}$

Was this page helpful?

Better Compute is created by Sean Filimon

Last updated

On this page