Purpose

Creates a group of On-Premises Connectors. The group can be used to support failover and load balancing across two or more On-Premises Connectors.

Note: An On-Premises Connector can be a member of only one Group. If you specify a ConnectorID that is a member of another group, the connectivity service returns an error, and the Connector is not added to the GroupConnector.

URL

https://<myserver>:<port>/api/mgmt/connectors

Method

POST

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a non-load balancer deployment, or the machine hosting the load balancer for a load balancer deployment. For a non-load balancer deployment, <port> is the port number specified as the Server Access Port during deployment. For a load balancer deployment, <port> must be either 80 for http or 443 for https. Whenever port 80 or 443 are used, it is not necessary to include the port number in the URL.

Request Payload Parameters

Parameter Description Valid Values
connectorGroup

data type: Object

 An object that contains a group of On-Premise connectors that can be used to support failover and load balancing across two or more On-Premises Connectors. An object of type connector_group_object, with the following parameters:
  • connectionTimeout: The amount of time, in seconds, that the connectivity service waits for a connection to be established. Required.
  • retryDelay: indicates the number of seconds the connectivity service considers the connector disabled. Required.
  • loadBalancing: Specifies whether to enable load balancing. Optional.
  • members: Specifies the connector ID of each On-Premises Connector in the group, the sequence in which each On-Premises Connector will be tried, and the weight to be applied to the connector. Required.
For more information, see connectorGroup Object.

Sample Request Payload

This request creates a new group connector to be owned by the current user comprised of three member On-Premises Connectors. Each member connector must already be registered to the owner. 
{
  "owner": "Rick",
  "label": "Production",
  "connectorGroup": {
      "connectionTimeout": 15,
      "retryDelay": 120,
      "loadBalancing": "Round Robin",
      "members": [
       {
         "memberID": "00000000-0000-0000-0011-000000000010",
         "sequence": 1,
         "weight": 60
       },
       {
         "memberID": "00021111-0011-0011-0022-000000222200",
         "sequence": 2,
         "weight": 20
       },
       {
         "memberID": "00031313-0011-0011-0033-000000333300",
         "sequence": 3,
         "weight": 20
      }
    ]
  },
  "authUser": [
    "Joe",
    "Fred",
    "Tom"
  ]
}

Response Definition

The response has the following format:

{
 "connectorID": <"group-connector-id">,
   "owner": <"owner-user-id">,
   "label": <"label">
   "connectorGroup": {
     "connectionTimeout": 15,
     "retryDelay": 120,
     "loadBalancing": "Round Robin",
     "members": [
      {
        "memberID": <"member-id">,
        "sequence": 1,
        "weight": 60
      },
      {
        "memberID": <"member-id">,
        "sequence": 2,
        "weight": 20
      },
      {
        "memberID": <"member-id">,
        "sequence": 3,
        "weight": 20
      }
    ]
  },
  "authUser": [
     <"authorized-user">,
     <"authorized-user">,
     <"authorized-user">
   ]
}

Sample Server Response

After sending in the payload successfully, the server response includes the above information and a newly generated ConnectorID for the On-Premise Connector Group . The user is also assigned as the owner of the Connector Group.
Note: The newly generated ConnectorID is also referred to as a Connector Group ID. You must specify this Connector Group ID in a data source to implement failover and load balancing.

{
  "connectorID": "12345678-90ab-cdef-ghij-klmnopqrstuv",
  "owner": "Rick",
  "label": "Production",
  "connectorGroup": {
     "connectionTimeout": 15,
     "retryDelay": 120,
     "loadBalancing": "Round Robin",
     "members": [
      {
        "memberID": "00000000-0000-0000-0011-000000000010",
        "sequence": 1,
        "weight": 60
      },
      {
        "memberID": "00021111-0011-0011-0022-000000222200",
        "sequence": 2,
        "weight": 20
      },
      {
        "memberID": "00031313-0011-0011-0033-000000333300",
        "sequence": 3,
        "weight": 20
      }
    ]
  },
  "authUser": [
     "Joe",
     "Fred",
     "Tom"
  ]
}

Authentication

Basic Authentication using Login ID and Password.

Authorization

Any active Hybrid Data Pipeline user