ProtocolAdapterAvailability Data Shape
The ProtocolAdapterAvailability Data Shape defines fields for the GetProtocolAdaptersWithAvailability service. This service is available for ThingWorx Azure IoT Hub Connectors operating in a ThingWorx High Availability (HA) Clustering environment. For information about ThingWorx High Availability (HA) Clustering, refer to ThingWorx High Availability in the ThingWorx Platform 9 help center.
Fields for ProtocolAdapterAvailability Data Shape
The following table lists and describes the fields defined by this Data Shape.
Field
BaseType
Description
name
STRING
Used to return the name(s) of the Connector(s) in the specified availability group.
availabilityGroup
STRING
Use this field to specify the name of the availability group for which you want to retrieve names of Connectors that belong to it.
healthState
STRING
Used to return the health status of this availability group
healthStateUpdated
DATETIME
Used to return the last date and time that the health state of this availability group was updated.
active
BOOLEAN
Used to indicate whether a Connector is currently the active node in the availability group. A value of true indicates that a Connector is the currently active node in the availability group. A value of false indicates that it is not the currently active node. e