ClusterConnectionStatus is an interface datatype for information about the status of a cluster connection.

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

As an interface, ClusterConnectionStatus is implemented by two datatypes: LocalClusterConnectionStatus; and RemoteClusterConnectionStatus.

Table: ClusterConnectionStatus

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: Apr 2, 2025
errorMessages[ConnectionAspectErrorType]yes Short-TermErrors if the connection is invalid. See ConnectionAspectErrorType.
idstring  Short-TermThe unique identifier of the connection.
isValidbooleanyes Short-TermWhether the connection is valid.