ClusterConnection is an interface datatype for information on cluster connections.

This datatype is used by another datatype, View, which is used by several other datatypes for giving or requesting relative infomation on users.

As an interface, ClusterConnection is implemented by two datatypes: LocalClusterConnection; and RemoteClusterConnection.

Table: ClusterConnection

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 17, 2024
clusterIdstringyes Short-TermThe cluster identity of the connection.
idstringyes Short-TermThe unique identifier of the connection.
queryPrefixstringyes Short-TermThe cluster connection query prefix.
tags[ClusterConnectionTag]yes Short-TermThe cluster connection tags. See ClusterConnectionTag.