List Events¶

List events

URI Template

GET /api/archive/{instance}/events

{instance}

Yamcs instance name.

Query Parameters

pos

The zero-based row number at which to start outputting results. Default: 0

limit

The maximum number of returned records per page. Choose this value too high and you risk hitting the maximum response size limit enforced by the server. Default: 100

order

The order of the returned results. Can be either asc or desc. Default: desc

severity

The minimum severity level of the events. One of info, watch, warning, distress, critical or severe. Default: info

source

The source of the events. Names must match exactly.

next

Continuation token returned by a previous page response.

start

Filter the lower bound of the event's generation time. Specify a date string in ISO 8601 format. This bound is inclusive.

stop

Filter the upper bound of the event's generation time. Specify a date string in ISO 8601 format. This bound is exclusive.

q

Text to search for in the message.

Response Type

interface ListEventsResponse {
  event: Event[];

  // Token indicating the response is only partial. More results can then
  // be obtained by performing the same request (including all original
  // query parameters) and setting the ``next`` parameter to this token.
  continuationToken: string;
}

Related Types

interface Event {
  source: string;
  generationTime: string;  // RFC 3339 timestamp
  receptionTime: string;  // RFC 3339 timestamp
  seqNumber: number;
  type: string;
  message: string;
  severity: EventSeverity;

  // Set by API when event was posted by a user
  createdBy: string;

  // Additional properties
  extra: {[key: string]: string};
}

enum EventSeverity {
  INFO = "INFO",
  WARNING = "WARNING",
  ERROR = "ERROR",
  WATCH = "WATCH",
  DISTRESS = "DISTRESS",
  CRITICAL = "CRITICAL",
  SEVERE = "SEVERE",
}