skip to main content
Hybrid Data Pipeline API reference : Management API : Connector API : Get the List of On-Premises Connectors in an On-Premises Connector Group
  

Try Now
Get the List of On-Premises Connectors in an On-Premises Connector Group

Purpose

Retrieve the list of On-Premises Connectors in an On-Premises Connector group.

URL

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

Method

GET

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a standalone installation, or the machine hosting the load balancer for a load balancer installation. For a standalone installation, <port> is the port number specified as the Server Access Port during installation. For a load balancer installation, <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.
<connector-ID> is a unique value associated with the group On-Premises Connector. The value is returned using the <base>/connectors/ GET request. The authorized user must be the owner of the group On-Premises Connector specified.

Response Definition

The response has the following format:
{
"members":[
{
<memberID>,
<sequence>,
<weight>
},
{
<memberID>,
<sequence>,
<weight>
},
{
<memberID>,
<sequence>,
<weight>
}
]
}
Parameter
Data Type
Description
Valid Values
members [memberID,sequence,weight ]
Array [String]
Specifies the connector ID of each On-Premises Connector in the group.
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 Server Response

{
"members":[
{
"memberID": "00001110-0000-0000-0000-000000001111",
"sequence": 1,
"weight": 1
},
{
"memberID": "00002220-0000-0000-0000-000000002222",
"sequence": 2,
"weight": 2
}
]
}

Authentication

Basic Authentication using Login ID and Password.

Authorization

Any active Hybrid Data Pipeline user. The authenticated user must be the owner of the group On-Premises Connector.