---
title: "List inlong groups by paginating"
method: POST
path: "/inlong/manager/openapi/group/list"
tags: ["Open-InLongGroup-API"]
---

# List inlong groups by paginating

`POST /inlong/manager/openapi/group/list`

## Request

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

## Request body

- InlongGroupQueryRequest
  - `clusterTagList` string[]: The inlong cluster tag list
  - `groupIdList` string[]: Inlong group id list
  - `inlongGroupMode` integer: Standard mode(include Data Ingestion and Synchronization): 0, DataSync mode(only Data Synchronization): 1
  - `keyword` string: Keyword, can be group id or name
  - `mqType` string: MQ type
  - `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: Group status
  - `statusList` integer[]: Group status list

## Response `200`

OK

- ResponseListInlongGroupBriefInfo
  - `data` InlongGroupBriefInfo[]
    - `createTime` string, date-time
    - `creator` string: Name of creator
    - `extParams` string: Inlong cluster tag, which links to inlong_cluster table
    - `id` integer: Primary key
    - `inCharges` string: Name of responsible person, separated by commas
    - `inlongClusterTag` string: Inlong cluster tag, which links to inlong_cluster table
    - `inlongGroupId` string: Inlong group id
    - `modifier` string: Name of modifier
    - `modifyTime` string, date-time
    - `mqResource` string: MQ resource
    - `mqType` string: MQ type, high throughput: TUBEMQ, high consistency: PULSAR
    - `name` string: Inlong group name
    - `status` integer: Status
    - `streamSources` StreamSourceInfo[]: Stream sources in the inlong group
      - `agentIp` string: Ip of the agent running the task
      - `createTime` string, date-time
      - `creator` string: Creator
      - `dataNodeName` string: Data node name
      - `fieldList` StreamFieldConfiguration[]
        - `extParams` string: Extra Param in JSON style
        - `fieldComment` string: Field comment
        - `fieldFormat` string: Field format, including: MICROSECONDS, MILLISECONDS, SECONDS, SQL, ISO_8601 and custom such as 'yyyy-MM-dd HH:mm:ss'. This is mainly used for time format
        - `fieldName` string, required: Field name
        - `fieldType` string, required: Field type
        - `fieldValue` string: Field value for constants
        - `id` integer: Field index
        - `inlongGroupId` string, required: inlong group id
        - `inlongStreamId` string, required: inlong stream id
        - `isMetaField` integer: Is this field a meta field, 0: no, 1: yes
        - `isPredefinedField` integer: Is predefined field, 1: yes, 0: no
        - `metaFieldName` string: Meta field name
        - `originFieldName` string: Origin field name before transform operation
        - `originNodeName` string: Origin node name which stream fields belong
        - `preExpression` string: Value expression of predefined field
      - `id` integer: Source id
      - `ignoreParseError` boolean: Whether to ignore the parse errors of field value, true as default
      - `inlongClusterName` string: Inlong cluster name
      - `inlongClusterNodeTag` string: Inlong cluster node tag
      - `inlongGroupId` string: Inlong group id
      - `inlongStreamId` string: Inlong stream id
      - `modifier` string: Modifier
      - `modifyTime` string, date-time
      - `postNodes` string[]
      - `preNodes` string[]
      - `previousStatus` integer: Previous status
      - `properties` object: Properties for source
      - `serializationType` string: Data Serialization, support: csv, json, canal, avro, etc
      - `snapshot` string: Snapshot of this source task
      - `sourceName` string: Source name, unique in one stream
      - `sourceType` string: Source type, including: FILE, KAFKA, etc.
      - `status` integer: Status
      - `subSourceList` SubSourceDTO[]: Sub source information of existing agents
        - `agentIp` string: Agent ip of sub source
        - `id` integer: stream source id
        - `status` integer: Status of sub source
        - `templateId` integer: Template source id this sub source belongs to
      - `templateId` integer: Null if not a sub source
      - `uuid` string: Mac uuid of the agent running the task
      - `version` integer: Version
  - `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)