---
title: "List group heartbeats"
method: POST
path: "/inlong/manager/api/heartbeat/group/list"
tags: ["Heartbeat-API"]
---

# List group heartbeats

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

## Request

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

## Request body

- BaseHeartbeatPageRequest
  - `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...
  - `orderField` string: Order field, support create_time and modify_time, default is create_time
  - `orderType` string: Order type, only support asc and desc, default is desc
  - `pageNum` integer: Current page number, default is 1
  - `pageSize` integer: Page size, default is 10

## Response `200`

OK

- ResponsePaginatedQueryResultsInlongGroupHeartbeatResponse
  - `data` PaginatedQueryResultsInlongGroupHeartbeatResponse
    - `list` InlongGroupHeartbeatResponse[], required: data record
      - `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
    - `pageNum` integer, required: pageNum
    - `pageSize` integer, required: pageSize
    - `total` integer, required: The total number of items matching the filter criteria
  - `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)