skip to main content
Hybrid Data Pipeline API reference : Management API : Connector API : Get Connector Information
  

Try Now
Get Connector Information

Purpose

Allows the owner to retrieve information about the members of one or more On-Premises Connectors in a connector group: member ID, sequence, and weight.

URL

https://<myserver>:<port>/api/mgmt/connectors/<connector-ID>
where
<myserver> is the DSN name or the IP address of the machine where Hybrid Data Pipeline is installed.
Note: Unless the ports 80 and 443 are redirected to 8080 and 8443 respectively, you must specify <myserver>:<port>.
<connector-ID> is a unique value associated with the On-Premises Connector. The value is returned using the https://<myserver>:<port>/api/mgmt/connectors GET request. The authorized user must be the owner of the On-Premises Connector specified.

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.

Response Definition

The response has the following format:

{
"connectorID": <"connector-id">,
"owner": <"owner-user-id">,
"label": <Label>,
"connectorGroup": {
"connectionTimeout": 15,
"retryDelay": 120,
"loadBalancing": "Round Robin",
"members": [
{
"memberID": "<memberId>",
"sequence": 1,
"weight": 1
}
]
},
"authUser":[
<"authorized-user">,
<"authorized-user">,
…
<"authorized-user">
]
}
where:
Parameter
Description
Valid Values
authUser
data type: Array
Specifies the list of users who have been granted permission to use the On-Premises Connectors in the group.
A comma-separated list of users who have been authorized by the owner of the group. Required; can be empty
connectorID
data type: String
The Connector ID of the On-Premises Connector for which information is returned.
The ID for the Connector. Either the Connector ID assigned to the Connector during installation or the label defined for the Connector can be used.Required
connectorGroup
data type: Object
Only present if the given connector is a group connector ID.
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.
groups
An object that contains a list of the Connector Groups the Connector is a member of. This object is included in the response only when includeGroups is set to true.
*connectorGroupIds: An array that specifies the Connector Group ID for each group. The array is always present. If the Connector is not a member of any groups, the array is empty.
owner
data type: String
The Progress ID of the owner of the Connector. Optional
A Progress ID. If owner is specified, its value must match the current owner of the Connector or Connector Group. Changing the owner of a Connector or Connector Group is not supported.

Sample Server Response

{
"connectorID": "abcdef01-fedc-abcd-bcde-0123456789ab",
"owner": "Rick",
"label": "MyConnector",
"connectorGroup": {
"connectionTimeout": 15,
"retryDelay": 120,
"loadBalancing": "Round Robin",
"members": [
{
"memberID": "00000000-0000-0000-0000-000000000000",
"sequence": 1,
"weight": 1
}
]
},
"authUser": [
"Joe",
"Fred",
"Tom"
]
}

Authentication

Basic Authentication using Login ID and Password.

Authorization

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