connectionTimeout

String

The amount of time, in seconds, that the connectivity service waits for a connection to be established before timing out the connection request.

Optional

0 | x where x is a positive integer that represents a number of seconds.

If set to 0, the connectivity service does not time out a connection request. If set to x, the connectivity service waits for the specified number of seconds before giving up on the current connection attempt and attempting to establish a connection through the next connector in the group. If all of the connectors in the group are tried without establishing a connection, control is returned to the application and a timeout error is generated.

The default is 15.

retryDelay

String

When a connection attempt through a particular connector fails, that connector is temporarily disabled in the group to stop connection attempts to a connector that has failed.

The value specified for retryDelay indicates the number of seconds the connectivity service considers the connector disabled. The connectivity service does not make any connection attempts. After the retryDelay period has expired, the connector is automatically re-enabled and connection attempts are sent to that connector again.

If all of the connectors in a group become disabled at the same time, the connectivity service attempts a connection to each connector in the group instead of suspending all connection attempts until the retryDelay has expired.

Optional

0 | x where x is a positive integer that represents a number of seconds.

If set to 0, the connectivity service does not delay between retries. If set to x, the connectivity service waits between connection retry attempts the specified number of seconds.

The default is 120.

loadBalancing

String

Specifies whether to balance requests across multiple On-Premises Connectors in a connector group.

Optional

If set to Round Robin, a round-robin algorithm is used to handle traffic among a group of On-Premises Connectors.

members [memberID,sequence,weight]

Array [String,int,int]

Specifies the connector ID of each On-Premise Connector in the group, the sequence in which each On-Premise Connector will be tried, and the weight to be applied to the connector.

Required

memberID is the Connector ID of the On-Premises Connector. It must not be the Connector ID of an On-Premises Connector Group. Nested groups are not supported.

sequence, for non-load-balanced connector groups, is the relative order in which the On-Premise Connector is tried. The value of the sequence property for each member object must be unique. Duplicate sequence values are not supported and will generate an error response.

weight, for load-balanced connector groups, sets the load for each Connector, with a higher number indicating the relative load directed to the given Connector. For example, if a load-balanced connector group contains connectors A, B and C with weights of 3, 2 and 1 respectively, then for every 6 connections three would go to A, two to B and 1 to C. Moreover, weights do not have to be relative to 1. Rather, they are relative to the other weights in the group. For example, if a group has three connectors with weights 3, 3 and 4, then thirty percent of the requests will go to the first connector, thirty percent will go to the second connector, and forty percent will go to the third connector. The default value is 1.