COconfluent
Cluster Linking (v3)

Describe the cluster link

Generally Available

link_id in ListLinksResponseData is deprecated and may be removed in a future release. Use the new cluster_link_id instead.

get/kafka/v3/clusters/{cluster_id}/links/{link_name}

Request

  • Base URL
    https://pkc-00000.region.provider.confluent.cloud
  • URL
    https://pkc-00000.region.provider.confluent.cloud/kafka/v3/clusters/{cluster_id}/links/{link_name}
  • Auth
    • HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://api.confluent.cloud/sts/v1/oauth2/token

Query parameters

include_tasksboolean

Whether to include cluster linking tasks in the response. Default: false

Response

Single link name and properties

kindstring required
source_cluster_idstring nullable
destination_cluster_idstring nullable
remote_cluster_idstring nullable
link_namestring required
link_idstring
cluster_link_idstring required
topic_namesstring[] required
link_errorstring
link_error_messagestring nullable
link_statestring

Example response

{
  "category_counts": [
    {
      "count": 123
    }
  ]
}

Changes

No recorded changes to this operation across all 7 revisions of this API.