List Events¶

List events

Two alternative URI forms can be used. The GET method is convenient, while the POST method allows passing long filter expressions.

URI Template

GET /api/archive/{instance}/events

POST /api/archive/{instance}/events:list

{instance}

Yamcs instance name

Query Parameters

pos

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

This option is deprecated and will be removed in a later version. Use the returned continuationToken instead.

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.

filter

Filter query. See Filtering for how to write a filter query.

Literal text search matches against the message, source and type fields. Field comparisons can use any of the following fields:

Field	Type	Description
message	string	Filter by message text
seqNumber	number	Filter by archived sequence number
severity	enum	Filter by event severity
source	string	Filter by event source
type	string	Filter by event type

Possible severities: info, watch, warning, distress, critical or severe.

Response Type

interface ListEventsResponse {

  // Deprecated, use `events` instead
  event: Event[];

  // Page with matching events
  events: 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",

  // Legacy, avoid use.
  ERROR = "ERROR",
  WATCH = "WATCH",

  // Placeholder for future WARNING constant.
  // (correctly sorted between WATCH and DISTRESS)
  //
  // Most clients can ignore, this state is here
  // to give Protobuf clients (Python Client, Yamcs Studio)
  // the time to add a migration for supporting both WARNING
  // and WARNING_NEW (Protobuf serializes the number).
  //
  // Then in a later phase, we move from:
  // WARNING=1, WARNING_NEW=4
  //
  // To:
  // WARNING_OLD=1, WARNING=4
  //
  // (which is a transparent change to JSON clients)
  WARNING_NEW = "WARNING_NEW",
  DISTRESS = "DISTRESS",
  CRITICAL = "CRITICAL",
  SEVERE = "SEVERE",
}