---
title: "List cluster nodes"
method: POST
path: "/inlong/manager/openapi/cluster/node/list"
tags: ["Open-Cluster-API"]
---

# List cluster nodes

`POST /inlong/manager/openapi/cluster/node/list`

## Request

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

## Request body

- InlongClusterPagingQueryRequest
  - `clusterTag` string: Cluster tag
  - `clusterTagList` string[]: The inlong cluster tag list
  - `displayName` string: Cluster display name, just for display
  - `extTag` string: Extend tag
  - `keyword` string: Keywords, name, url, cluster tag, etc.
  - `name` string: Cluster 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
  - `parentId` integer: Parent cluster ID, used for cluster node
  - `protocolType` string: Protocol type, such as: TCP, HTTP
  - `status` integer: Status
  - `type` string: Cluster type, including TUBEMQ, PULSAR, DATAPROXY, etc.
  - `typeList` string[]: Cluster type list

## Response `200`

OK

- ResponseListClusterNodeResponse
  - `data` ClusterNodeResponse[]
    - `createTime` string, date-time
    - `creator` string: Name of in creator
    - `description` string: Description of the cluster node
    - `extParams` string: Extended params
    - `id` integer: Primary key
    - `ip` string: Cluster IP
    - `modifier` string: Name of in modifier
    - `modifyTime` string, date-time
    - `nodeLoad` integer: Load value of the node
    - `nodeTags` string: Cluster node tag, separated by commas
    - `parentId` integer: ID of the parent cluster
    - `port` integer: Cluster port
    - `protocolType` string: Cluster protocol type
    - `status` integer: Cluster status
    - `type` string: Cluster type, including AGENT, DATAPROXY, etc.
    - `version` integer: Version number
  - `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)