---
title: "Get group heartbeat"
method: POST
path: "/inlong/manager/api/heartbeat/group/get"
tags: ["Heartbeat-API"]
---

# Get group heartbeat

`POST /inlong/manager/api/heartbeat/group/get`

## Request

- The document declares no server URL.
- Auth: none declared

## Request body

- HeartbeatQueryRequest
  - `component` string: Component name, such as: Agent, Sort...
  - `inlongGroupId` string: Inlong group id
  - `inlongStreamId` string: Inlong stream id
  - `instance` string: Component instance, can be ip, name...

## Response `200`

OK

- ResponseInlongGroupHeartbeatResponse
  - `data` InlongGroupHeartbeatResponse
    - `component` string: Component name, such as: Agent, Sort...
    - `id` integer: Primary key
    - `inlongGroupId` string: Inlong group id
    - `instance` string: Component instance, can be ip, name...
    - `metricHeartbeat` string: Stream metric heartbeat
    - `modifyTime` string, date-time
    - `reportTime` integer: Report time of heartbeat
    - `statusHeartbeat` string: Stream status heartbeat
  - `errMsg` string
  - `success` boolean

## Other responses

- `201`: Created
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

---

[API](https://skmtc.dev/apache/apis/the-apache-software-foundation-file-api.md) - [All operations](https://skmtc.dev/apache/apis/the-apache-software-foundation-file-api/llms.txt) - [OpenAPI document](https://skmtc.dev/apache/apis/the-apache-software-foundation-file-api/revisions/41c687f48683?raw)