GET cluster

This web method retrieves the status of the FTL server cluster.

The response includes information about the cluster as a whole, plus information about each FTL server in the cluster.

Example Requests

curl -X GET http://<host>:<port>/api/v1/cluster

Example Response

{
  "server_name": "ftls1",
  "leader": "ftls3",
  "component_count": {
    "bridge_server_count": 0,
    "eftl_cluster_count": 0,
    "group_client_count": 0,
    "group_server_count": 3,
    "persistence_server_count": 3,
    "satellite_count": 0,
    "ftl_server_count": 3,
    "other_service_count": 9,
    "service_count": 18,
    "client_count": 0,
    "total_client_count": 18,
    "cumulative_client_count": 18,
    "cumulative_total_client_count": 18,
    "timed_out_client_count": 0
  },
  "members": [
    {
      "server_name": "ftls1",
      "server_host": "host6",
      "server_port": 9199,
      "server_type": "core",
      "server_status": "online",
      "server_uuid": "403d24cf-acb5-46ba-ae36-064dfb5f96ed",
      "server_label": "127.0.0.1:35864",
      "realm_uuid": "76a2709f-201d-4541-a5d7-4c701e522a66",
      "realm_revision": 300,
      "client_count": 8,
      "leader": "ftls3",
      "url": "http://127.0.0.1:35864",
      "component_count": {
        "bridge_server_count": 0,
        "eftl_cluster_count": 0,
        "group_client_count": 0,
        "group_server_count": 1,
        "persistence_server_count": 1,
        "satellite_count": 0,
        "ftl_server_count": 1,
        "other_service_count": 3,
        "service_count": 6,
        "client_count": 0,
        "total_client_count": 6,
        "cumulative_client_count": 6,
        "cumulative_total_client_count": 6,
        "timed_out_client_count": 0
      },
      "satellites": [],
      "startup_time": "Tue, 02 Aug 2022 13:04:25 PDT",
      "startup_time_millis": 1659470665954,
      "mode": "STANDALONE/PRIMARY",
      "mode_label": "Running"    
    },
    {
      "server_name": "ftls2",
      "server_host": "host6",
      "server_port": 9299,
      "server_type": "core",
      "server_status": "online",
      "server_uuid": "96510be0-d83a-47f0-a715-df1ab0c9fecb",
      "server_label": "127.0.0.1:36818",
      "realm_uuid": "76a2709f-201d-4541-a5d7-4c701e522a66",
      "realm_revision": 300,
      "client_count": 8,
      "leader": "ftls3",
      "url": "http://127.0.0.1:36818",
      "component_count": {
        "bridge_server_count": 0,
        "eftl_cluster_count": 0,
        "group_client_count": 0,
        "group_server_count": 1,
        "persistence_server_count": 1,
        "satellite_count": 0,
        "ftl_server_count": 1,
        "other_service_count": 3,
        "service_count": 6,
        "client_count": 0,
        "total_client_count": 6,
        "cumulative_client_count": 6,
        "cumulative_total_client_count": 6,
        "timed_out_client_count": 0
      },
      "satellites": [],
      "startup_time": "Tue, 02 Aug 2022 13:04:25 PDT",
      "startup_time_millis": 1659470665954,
      "mode": "STANDALONE/PRIMARY",
      "mode_label": "Running"
    },
    {
      "server_name": "ftls3",
      "server_host": "host6",
      "server_port": 9399,
      "server_type": "core",
      "server_status": "online",
      "server_uuid": "30669c79-55e6-44c1-96a1-e2dcc8b0388b",
      "server_label": "127.0.0.1:59792",
      "realm_uuid": "76a2709f-201d-4541-a5d7-4c701e522a66",
      "realm_revision": 300,
      "client_count": 8,
      "leader": "ftls3",
      "url": "http://127.0.0.1:59792",
      "component_count": {
        "bridge_server_count": 0,
        "eftl_cluster_count": 0,
        "group_client_count": 0,
        "group_server_count": 1,
        "persistence_server_count": 1,
        "satellite_count": 0,
        "ftl_server_count": 1,
        "other_service_count": 3,
        "service_count": 6,
        "client_count": 0,
        "total_client_count": 6,
        "cumulative_client_count": 0,
        "cumulative_total_client_count": 6
        "timed_out_client_count": 0
      },
      "satellites": [],
      "startup_time": "Tue, 02 Aug 2022 13:04:25 PDT",
      "startup_time_millis": 1659470665954,
      "mode": "STANDALONE/PRIMARY",
      "mode_label": "Running"
    }
  ]
}