---
title: "List cluster by tenant condition"
method: POST
path: "/inlong/manager/api/cluster/listByTenantRole"
tags: ["Inlong-Cluster-API"]
---

# List cluster by tenant condition

`POST /inlong/manager/api/cluster/listByTenantRole`

## 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

- ResponsePaginatedQueryResultsInlongClusterInfo
  - `data` PaginatedQueryResultsInlongClusterInfo
    - `list` InlongClusterInfo[], required: data record
      - `clusterTags` string: Cluster tags, separated by commas
      - `createTime` string, date-time
      - `creator` string: Name of in creator
      - `description` string: Description of the cluster
      - `displayName` string: Cluster display name, just for display
      - `extParams` string: Extended params
      - `extTag` string: Extension tag
      - `heartbeat` string: Cluster heartbeat info
      - `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: Cluster name
      - `status` integer: Cluster status
      - `token` string: Cluster token
      - `type` string: Cluster type, including TUBEMQ, PULSAR, KAFKA, DATAPROXY, etc.
      - `url` string: Cluster url
      - `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)