---
title: "Update cluster by key"
method: POST
path: "/inlong/manager/api/cluster/updateByKey"
tags: ["Inlong-Cluster-API"]
---

# Update cluster by key

`POST /inlong/manager/api/cluster/updateByKey`

## Request

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

## Request body

- InlongClusterRequest
  - `clusterTags` string: Cluster tags, separated by commas
  - `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 responsible person, separated by commas
  - `name` string: Cluster name
  - `token` string: Cluster token
  - `type` string: Cluster type, including TUBEMQ, PULSAR, KAFKA, DATAPROXY, etc.
  - `url` string: Cluster url
  - `version` integer: Version number

## Response `200`

OK

- ResponseUpdateResultInfo
  - `data` UpdateResultInfo
    - `id` integer: ID of the current record
    - `success` boolean: Update result, true or false
    - `version` integer: Version of the current record after updating
  - `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)