Endpoint

/v1/portal/quorum/events

GET

List recent portal quorum success and abandon events recorded by the nodes of this cluster, oldest first. Success events are recorded by the cluster quorum leader; abandon events are recorded by each node that observed a reason for the abandon. History is bounded by event log rotation; roughly the trailing 24 hours are available.

Parameters

Name Description Required
begin-time Inclusive lower bound on event time, in RFC 3339 format or epoch seconds. If not specified, all available history is returned. No
end-time Exclusive upper bound on event time, in RFC 3339 format or epoch seconds. If not specified, defaults to the current system time. No
type Only return events of this kind: success or abandon.: * `abandon` - abandon, * `success` - success No
node-id Only return events recorded by this node. No
filesystem-uuid Only return events for the filesystem with this UUID, as reported by the filesystem_uuid of a hub or spoke portal. No
limit Maximum entries returned, oldest first. Defaults to 1000. No

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "v1_portal_quorum_events",
  "type": "object",
  "properties": {
    "entries": {
      "type": "array",
      "items": {
        "description": "Matching events from all queried nodes, oldest first",
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "success",
              "abandon"
            ],
            "description": "Event kind: success (portal quorum formed) or abandon:\n * `abandon` - PORTAL_QUORUM_EVENT_KIND_ABANDON,\n * `success` - PORTAL_QUORUM_EVENT_KIND_SUCCESS"
          },
          "node_id": {
            "description": "Node that recorded the event",
            "type": "number"
          },
          "event_time": {
            "description": "When the node recorded the event",
            "type": "string"
          },
          "portal_quorum_id": {
            "description": "portal_quorum_id",
            "type": "object",
            "properties": {
              "portal_quorum_seq": {
                "description": "portal_quorum_seq",
                "type": "string"
              }
            }
          },
          "filesystem_uuid": {
            "description": "UUID of the filesystem the portal quorum serves",
            "type": "string"
          },
          "total_clusters": {
            "description": "Total clusters this node knows about, in quorum or not",
            "type": "number"
          },
          "missing_clusters": {
            "type": "array",
            "items": {
              "description": "Cluster UUIDs missing from the portal quorum",
              "type": "string"
            }
          },
          "end_reason": {
            "description": "Why the portal quorum was abandoned; abandon events only",
            "type": "string"
          },
          "end_reason_kind": {
            "type": "string",
            "enum": [
              "peer_requested",
              "peer_disconnected",
              "local_requested"
            ],
            "description": "Who ended the portal quorum, as a cause rather than as text; abandon events only:\n * `local_requested` - PORTAL_QUORUM_ABANDON_KIND_LOCAL_REQUESTED,\n * `peer_disconnected` - PORTAL_QUORUM_ABANDON_KIND_PEER_DISCONNECTED,\n * `peer_requested` - PORTAL_QUORUM_ABANDON_KIND_PEER_REQUESTED"
          },
          "uptime": {
            "description": "Seconds the portal quorum was active; abandon events only",
            "type": "number"
          },
          "downtime": {
            "description": "Seconds since the previous portal quorum abandoned; success events only",
            "type": "number"
          },
          "formation_time": {
            "description": "Seconds this node spent starting; success events only",
            "type": "number"
          }
        }
      }
    },
    "nodes_queried": {
      "type": "array",
      "items": {
        "description": "Nodes whose event logs contributed; nodes outside cluster quorum are absent and their events are unavailable until they rejoin",
        "type": "number"
      }
    }
  }
}