Purpose

Returns a list of available nodes and their IDs.

URL

https://<myserver>:<port>/api/admin/system/nodes

Method

GET

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.

Response Definition

{
  "nodes": [
    {
      "url": "hdp_node1",
      "id": node1_id
    },
    {
      "url": "hdp_node2",
      "id": node2_id
    },
    {
      "url": "hdp_node3",
      "id": node3_id
    }
  ]
}
Property Description Valid Values
"url" The endpoint of the node. The URL of the node
"id" The ID of the node. The ID is auto-generated when the node is created. The ID of a node cannot be changed.

Sample Server Success Response 


      Status code: 200
      Successful response
            
{
  "nodes": [
    {
      "url": "https://node1.example.com",
      "id": 1
    },
    {
      "url": "https://node2.example.com",
      "id": 2
    }
    {
      "url": "https://node3.example.com",
      "id": 3
    }
  ]
}

Sample Server Failure Response 

{
  "error": {
    "code": 222207919,
    "message": {
      "lang": "en-US",
      "value": "Problem getting Nodes at this time. Please try again at another time."
    }
  }
}

Authentication

Basic Authentication using Login ID and Password

Authorization

The user must have the Administrator (12) permission.