Models

ConnectionStatus

object

Status of a connection and its resources

connectionIdstringrequired

The connection ID

connectionStatusConnectivityStatusrequired

The desired/target status of the connection

Show child attributes

The status of a connection or resource

ConnectivityStatusopenclosedfailedmisconfiguredunknown
liveStatusConnectivityStatusrequired

The current/actual status of the connection

Show child attributes

The status of a connection or resource

ConnectivityStatusopenclosedfailedmisconfiguredunknown
connectedSincestringrequired

The timestamp since when the connection is connected

Example
2019-01-21T08:57:24.710Z
clientStatusArray<ResourceStatus>

The client states of the of the connection

Show child attributes

The status of a single resource (e.g. a client or a source/target resource)

typestringclientsourcetargetrequired

The type of the resource

clientstringrequired

A client identifier where the resource is held (e.g. a cluster instance ID)

addressstring

The address information of the resource (optional)

statusConnectivityStatusopenclosedfailedmisconfiguredunknownrequired

The status of a connection or resource

Same fields as connectionStatus

statusDetailsstring

Details to the status of the resource

inStateSincestring

Date since when the resource is in the present state

sourceStatusArray<ResourceStatus>

The states of the sources the of the connection

Show child attributes

The status of a single resource (e.g. a client or a source/target resource)

typestringclientsourcetargetrequired

The type of the resource

clientstringrequired

A client identifier where the resource is held (e.g. a cluster instance ID)

addressstring

The address information of the resource (optional)

statusConnectivityStatusopenclosedfailedmisconfiguredunknownrequired

The status of a connection or resource

Same fields as connectionStatus

statusDetailsstring

Details to the status of the resource

inStateSincestring

Date since when the resource is in the present state

targetStatusArray<ResourceStatus>

The states of the targets the of the connection

Show child attributes

The status of a single resource (e.g. a client or a source/target resource)

typestringclientsourcetargetrequired

The type of the resource

clientstringrequired

A client identifier where the resource is held (e.g. a cluster instance ID)

addressstring

The address information of the resource (optional)

statusConnectivityStatusopenclosedfailedmisconfiguredunknownrequired

The status of a connection or resource

Same fields as connectionStatus

statusDetailsstring

Details to the status of the resource

inStateSincestring

Date since when the resource is in the present state

sshTunnelStatusArray<ResourceStatus>

The states of the ssh tunnel the of the connection

Show child attributes

The status of a single resource (e.g. a client or a source/target resource)

typestringclientsourcetargetrequired

The type of the resource

clientstringrequired

A client identifier where the resource is held (e.g. a cluster instance ID)

addressstring

The address information of the resource (optional)

statusConnectivityStatusopenclosedfailedmisconfiguredunknownrequired

The status of a connection or resource

Same fields as connectionStatus

statusDetailsstring

Details to the status of the resource

inStateSincestring

Date since when the resource is in the present state

Docs by Sourcey
↑↓ navigate↵ selectesc close