---
title: "matcherStatus"
method: GET
path: "/status"
tags: ["status"]
---

# matcherStatus

`GET /status`

This method return the complete information of the cluster and its nodes.

## Response `200`

OK

- GetMatcherStatusResponse
  - `data` object
    - `configuredMatchers` integer — Number of matchers running on the cluster.
    - `peopleCount` integer — Sum of all people in the nodes.
    - `ulCount` integer — Sum of all ULs in the nodes.
    - `nodes` object[] — Array of nodes.
      - `hostname` string — Name of the node.
      - `monitorPort` integer — Port of the GBDS Monitor service.
      - `status` 'NONE' | 'SPRING_START' | 'CLUSTER_ASSEMBLY' | 'MATCHERS_ASSEMBLY' | 'PEOPLE_BOOT' | 'UL_BOOT' | 'KAFKA_START' | 'RUNNING' | 'SHUTTING_DOWN' — Status of the node.
      - `configuredMatchers` integer — Number of matchers running on the node.
      - `peopleCount` integer — Sum of all people in this node.
      - `ulCount` integer — Sum of all ULs in this node.
      - `memory` Memory
        - `FINGERPRINT` object
          - `size` integer
          - `total` integer
        - `PALMPRINT` object
          - `size` integer
          - `total` integer
        - `NEWBORN` object
          - `size` integer
          - `total` integer
        - `UL_FINGERPRINT` object
          - `size` integer
          - `total` integer
        - `UL_PALMPRINT` object
          - `size` integer
          - `total` integer
        - `FACE` object
          - `size` integer
          - `total` integer
        - `IRIS` object
          - `size` integer
          - `total` integer
      - `activeMatchers` object[] — Matchers running on the node.
        - `name` string — Name of the matcher.
        - `peopleCount` integer — Quantity of people in the matcher.
        - `ulCount` integer — Quantity of ULs in the matcher.
        - `memory` Memory
          - `FINGERPRINT` object
            - `size` integer
            - `total` integer
          - `PALMPRINT` object
            - `size` integer
            - `total` integer
          - `NEWBORN` object
            - `size` integer
            - `total` integer
          - `UL_FINGERPRINT` object
            - `size` integer
            - `total` integer
          - `UL_PALMPRINT` object
            - `size` integer
            - `total` integer
          - `FACE` object
            - `size` integer
            - `total` integer
          - `IRIS` object
            - `size` integer
            - `total` integer

## Other responses

- `500` — Internal error

---

[API](https://skmtc.net/griaule/apis/gbds-api.md) · [All operations](https://skmtc.net/griaule/apis/gbds-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/griaule/gbds-api/revisions/fa80f482ec5e/schema)