Skip to main content

nexigon_api.cluster.GetClusterDetailsOutput

Information about the cluster.

nodes object[]required
  • Array [
    • nodeIdnexigon_api.cluster.ClusterNodeId (string)required

    Unique ID of a cluster node.

    namestring
    statusstringrequired

    Status of a cluster node.

    Possible values: [Active, Terminated]

    joinedAtnexigon_api.datetime.Timestamp (string)required

    ISO 8601 formatted date and time string.

    uptimeSecsinteger<uint32>required
    lastHeartbeatnexigon_api.datetime.Timestamp (string)required

    ISO 8601 formatted date and time string.

    terminatedAtnexigon_api.datetime.Timestamp (string)

    ISO 8601 formatted date and time string.

    terminationReasonstring

    Reason why a cluster node was terminated.

    Possible values: [Unknown, HeartbeatTimeout, Shutdown]

  • ]
    • nexigon_api.cluster.GetClusterDetailsOutput
    {
      "nodes": [
        {
          "nodeId": "string",
          "name": "string",
          "joinedAt": "string",
          "uptimeSecs": 0,
          "lastHeartbeat": "string",
          "terminatedAt": "string"
        }
      ]
    }