RemoteClusterConnectionStatus is a datatype for the status of a remote cluster connection.

This datatype implements the interface datatype, ClusterConnectionStatus. It's used by the checkRemoteClusterConnection() query field.

Table: RemoteClusterConnectionStatus

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Jul 1, 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.
remoteServerCompatVersionstring  DeprecatedOldest server version that is protocol compatible with the remote server. This field is no longer used in deciding protocol compatibility. It will be removed in version 1.207.
remoteServerVersionstring  Short-TermSoftware version of the remote view.
remoteViewNamestring  Short-TermThe name of the remote view.