Purpose

Adds specified On-Premises Connectors to a group of On-Premise Connectors, and specifies the order in which each On-Premises Connector is tried in a failover scenario.

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

URL

https://<myserver>:<port>/api/mgmt/connectors/<connector-ID>/members

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.

Payload Parameters

Parameter Data Type Description Usage Valid Values
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.
Note: weight is optional. For non-load-balanced connector groups, weight is ignored.

Sample Request Payload

This request adds three On-Premises Connectors to an existing GroupConnector that contained only one On-Premises Connector. 

{
  "members": [
    {
       "memberID": "00000000-0000-0000-0044-000000000040",
       "sequence": 2,
       "weight": 4
    },
    {
       "memberID": "00021111-0011-0011-0055-000000555500",
       "sequence": 3,
       "weight": 3
    },
    {
       "memberID": "00061616-0011-0011-0063-000000363600",
       "sequence": 4,
       "weight": 2
    }
  ]
}

Response Definition

The response has the following format:

{
  "members":[
    {
       <"memberID">: <"memberID">,
	  <"sequence">: <sequence>,
	  <"weight">: <weight>
	 },
    {
       <"memberID">: <"memberID">,
	  <"sequence">: <sequence>,
	  <"weight">: <weight>
	 },
    {
       <"memberID">: <"memberID">,
	  <"sequence">: <sequence>,
	  <"weight">: <weight>
	}				
  ]
}

Sample Server Response

After sending in the payload, on success, the owner of the group connector receives a response with the following information. 
{
 "members":[
   {
     "memberID": "00000001-0000-0000-0001-000000000111",
     "sequence": 1,
     "weight": 1
   },
   {
     "memberID": "00000000-0000-0000-0044-000000000040",
     "sequence": 2,
      "weight": 4
   },
   {
     "memberID": "00021111-0011-0011-0055-000000555500",
     "sequence": 3,
     "weight": 3
   },
   {
     "memberID": "00061616-0011-0011-0063-000000363600",
     "sequence": 4,
     "weight": 2
   }
  ] 
}

Authentication

Basic Authentication using Login ID and Password.

Authorization

Any active Hybrid Data Pipeline user