---
title: "List data node"
method: POST
path: "/inlong/manager/api/node/list"
tags: ["Data-Node-API"]
---

# List data node

`POST /inlong/manager/api/node/list`

## Request

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

## Request body

- DataNodePagingQueryRequest
  - `displayName` string: Data node display name, just for display
  - `keyword` string: Keywords, name, url, etc.
  - `name` string: Data node 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
  - `status` integer: Status
  - `type` string: Data node type, including MYSQL, HIVE, KAFKA, ES, etc.

## Response `200`

OK

- ResponsePaginatedQueryResultsDataNodeInfo
  - `data` PaginatedQueryResultsDataNodeInfo
    - `list` DataNodeInfo[], required: data record
      - `createTime` string, date-time
      - `creator` string: Name of in creator
      - `description` string: Description of the data node
      - `displayName` string: Data node display name, just for display
      - `extParams` string: Extended params
      - `id` integer: Primary key
      - `inCharges` string: Name of in charges, separated by commas
      - `modifier` string: Name of in modifier
      - `modifyTime` string, date-time
      - `name` string: Data node name
      - `tenant` string: Inlong tenant to which the data node belongs
      - `token` string: Data node token if needed
      - `type` string: Data node type, including MYSQL, HIVE, KAFKA, ES, etc.
      - `url` string: Data node URL
      - `username` string: Data node username
      - `version` integer: Version number
    - `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)
