---
title: "List inlong consume by pagination"
method: POST
path: "/inlong/manager/api/consume/list"
tags: ["Inlong-Consume-API"]
---

# List inlong consume by pagination

`POST /inlong/manager/api/consume/list`

## Request

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

## Request body

- InlongConsumeQueryRequest
  - `consumerGroup` string: Consumer group name
  - `inlongGroupId` string: The target inlongGroupId of inlong consume
  - `keyword` string: Keyword, can be consumer group
  - `mqType` string: MQ type, high throughput: TUBEMQ, high consistency: PULSAR
  - `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
  - `status` integer: Consume status
  - `statusList` integer[]: Consume status list
  - `topic` string: The target topic of inlong consume

## Response `200`

OK

- ResponsePaginatedQueryResultsInlongConsumeBriefInfo
  - `data` PaginatedQueryResultsInlongConsumeBriefInfo
    - `list` InlongConsumeBriefInfo[], required: data record
      - `consumerGroup` string: Consumer group, only support [a-zA-Z0-9_]
      - `createTime` string, date-time
      - `creator` string: Name of creator
      - `id` integer: Primary key
      - `inCharges` string: Name of responsible person, separated by commas
      - `inlongGroupId` string: The target inlongGroupId of inlong consume
      - `modifier` string: Name of modifier
      - `modifyTime` string, date-time
      - `mqType` string: MQ type, high throughput: TUBEMQ, high consistency: PULSAR
      - `status` integer: Consume status
      - `topic` string: The target topic of inlong consume
    - `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)