Get peers

Returns details about the peers on the grid, such as name, description type, if it is a metric synchronization point, and if it is used to run workflows. You can retrieve all peers or a named peer.

You can also apply pattern to retrieve the peer details based on name, type, and status.

This topic includes the following sections:

Request

HTTP method: GET

Request URL: Use one of the following URLs.

To get a peer by name: https://<hostname>:<port>/baocdp/rest/peer/<peer_name>
In this URL, <peer_name> represents the name of the peer to retrieve.
For example, https://hostname:38080/baocdp/rest/peer/CDP
To get all peers: https://<hostname>:<port>/baocdp/rest/peer
You can also specify pattern to retrieve peers. For example, https://hostname:38080/baocdp/rest/peer?pattern=CDP&matchon=type

Header: See HTTP request and response headers for header information, such as required authentication token.

URL query parameters

Parameter	Type	Required	Description	Values
pattern	string	No	Pattern for retrieving the peer information	User-provided
matchon	string	No	Attribute for which the value will be used to apply the regular expression for filtering (using the pattern provided)	User-provided

Request body properties

This call does not require a request body.

Response

If successful, this method returns details about the peer(s) on the grid.

Response body properties

Property	Description
name	Peer name
description	Peer description
type	Peer type
metricsynchPoint	If the peer is used as a synchronization point for uploading metrics (true or false)
workflowServer	If the peer will service SOAP requests to run workflows (true or false)
adaptersStatus	Information about adapters on the peer
loggingInfo	Information about logging configurations on the peer
peerComponents	Information about components on the peer

Example response JSON

[
  {
    "name": "CDP",
    "description": "",
    "type": "CDP",
    "metricsyncPoint": "false",
    "workflowServer": "true",

    "adaptersStatus": [
      {
        "adapterId": "AdapterConfiguration1490620719893-989337527",
        "name": "SSH Adapter",
        "status": "Currently running",
        "peerName": "CDP",
        "peerId": "urn:jxta:uuid-59616261646162614E50472050325033A4A078EB2933478988D8F5A712D9915A03"
        },
     {
        "adapterId": "AdapterConfiguration1490620722096-1246806276",
        "name": "ws",
        "status": "Currently running",
        "peerName": "CDP",
        "peerId": "urn:jxta:uuid-59616261646162614E50472050325033A4A078EB2933478988D8F5A712D9915A03"
        }
    ],
    "loggingInfo": [
      {
        "componentName": "Adapters",
        "logLevel": "WARN"
      },
      {
        "componentName": "Configuration",
        "logLevel": "WARN"
      },
      {
        "componentName": "Health",
        "logLevel": "WARN"
      },
      {
        "componentName": "Utilities",
        "logLevel": "WARN"
      },  
      {
        "componentName": "Foundation",
        "logLevel": "WARN"
      },  
      {   
        "componentName": "Web Services",
        "logLevel": "WARN"
      },
      {
        "componentName": "Repository",
        "logLevel": "WARN"   
      },
      {     
        "componentName": "Shared Resources",
        "logLevel": "WARN"
      },
      {
        "componentName": "Grid Manager",
        "logLevel": "WARN"
      },
      {
        "componentName": "Adapter Framework",
        "logLevel": "WARN"
      },   
      {
        "componentName": "Scheduler",
        "logLevel": "WARN"
      },
      {
        "componentName": "Library Manager",
        "logLevel": "WARN"
      },  
      {
        "componentName": "Security",
        "logLevel": "WARN"
      },
      {
        "componentName": "Grid Framework",
        "logLevel": "WARN"
      },
      {
        "componentName": "Startup",
        "logLevel": "WARN"
      },
      {
        "componentName": "Auditing",
        "logLevel": "WARN"
      },
      {
        "componentName": "Context",
        "logLevel": "WARN"
      },
      {
        "componentName": "Metrics",
        "logLevel": "WARN"
      },
      {
        "componentName": "Activity Processor",
        "logLevel": "WARN"
      },
      {
        "componentName": "Operator Control Panel",
        "logLevel": "WARN"
      },
      {
        "componentName": "Grid Management",
        "logLevel": "WARN"
      },
      {
        "componentName": "Job Manager",
        "logLevel": "WARN"
      }
    ],
    "peerComponents": [
      {
        "componentId": "health",
        "name": "Health",
        "status": "Currently running"
      },
      {
        "componentId": "metrics",
        "name": "Metrics",
        "status": "Currently running"
      },
      {
        "componentId": "library_manager",
        "name": "Library Manager",
        "status": "Currently running"
      },
      {
        "componentId": "config",
        "name": "Config",
        "status": "Currently running"
      },
      {
        "componentId": "job_manager",
        "name": "Job Manager",
        "status": "Currently running"
      },
      {
        "componentId": "context",
        "name": "Context",
        "status": "Currently running"
      },
      {
        "componentId": "scheduler",
        "name": "Scheduler",
        "status": "Currently running"
      },
      {
        "componentId": "adapter_manager",
        "name": "Adapter Manager",
        "status": "Currently running"
      },
      {
        "componentId": "activity_processor",
        "name": "Activity Processor",
        "status": "Currently running"
      }
    ]
  }
]

Example response JSON for Get Peers by query parameters

[
	{
		"name": "LAP3",
		"description": "This is a light-weight activity peer.",
		"type": "LAP",
		"metricsyncPoint": "false",
		"workflowServer": "false",
		"adaptersStatus": [],
		"loggingInfo": [
			{
				"componentName": "Adapters",
				"logLevel": "WARN"
			},
			{
				"componentName": "Configuration",
				"logLevel": "WARN"
			},
			{
				"componentName": "Utilities",
				"logLevel": "WARN"
			},
			{
				"componentName": "Health",
				"logLevel": "WARN"
			},
			{
				"componentName": "Foundation",
				"logLevel": "WARN"
			},
			{
				"componentName": "Web Services",
				"logLevel": "WARN"
			},
			{
				"componentName": "Repository",
				"logLevel": "WARN"
			},
			{
				"componentName": "Shared Resources",
				"logLevel": "WARN"
			},
			{
				"componentName": "Grid Manager",
				"logLevel": "WARN"
			},
			{
				"componentName": "Scheduler",
				"logLevel": "WARN"
			},
			{
				"componentName": "Library Manager",
				"logLevel": "WARN"
			},
			{
				"componentName": "Adapter Framework",
				"logLevel": "WARN"
			},
			{
				"componentName": "Security",
				"logLevel": "WARN"
			},
			{
				"componentName": "Grid Framework",
				"logLevel": "WARN"
			},
			{
				"componentName": "Startup",
				"logLevel": "WARN"
			},
			{
				"componentName": "Auditing",
				"logLevel": "WARN"
			},
			{
				"componentName": "Context",
				"logLevel": "WARN"
			},
			{
				"componentName": "Metrics",
				"logLevel": "WARN"
			},
			{
				"componentName": "Activity Processor",
				"logLevel": "WARN"
			},
			{
				"componentName": "Operator Control Panel",
				"logLevel": "WARN"
			},
			{
				"componentName": "Grid Management",
				"logLevel": "WARN"
			},
			{
				"componentName": "Job Manager",
				"logLevel": "WARN"
			}
		],
		"peerComponents": []
	},
	{
		"name": "LAP1",
		"description": "This is a light-weight activity peer.",
		"type": "LAP",
		"metricsyncPoint": "false",
		"workflowServer": "false",
		"adaptersStatus": [],
		"loggingInfo": [
			{
				"componentName": "Adapters",
				"logLevel": "WARN"
			},
			{
				"componentName": "Configuration",
				"logLevel": "WARN"
			},
			{
				"componentName": "Utilities",
				"logLevel": "WARN"
			},
			{
				"componentName": "Health",
				"logLevel": "WARN"
			},
			{
				"componentName": "Foundation",
				"logLevel": "WARN"
			},
			{
				"componentName": "Web Services",
				"logLevel": "WARN"
			},
			{
				"componentName": "Repository",
				"logLevel": "WARN"
			},
			{
				"componentName": "Shared Resources",
				"logLevel": "WARN"
			},
			{
				"componentName": "Grid Manager",
				"logLevel": "WARN"
			},
			{
				"componentName": "Scheduler",
				"logLevel": "WARN"
			},
			{
				"componentName": "Library Manager",
				"logLevel": "WARN"
			},
			{
				"componentName": "Adapter Framework",
				"logLevel": "WARN"
			},
			{
				"componentName": "Security",
				"logLevel": "WARN"
			},
			{
				"componentName": "Grid Framework",
				"logLevel": "WARN"
			},
			{
				"componentName": "Startup",
				"logLevel": "WARN"
			},
			{
				"componentName": "Auditing",
				"logLevel": "WARN"
			},
			{
				"componentName": "Context",
				"logLevel": "WARN"
			},
			{
				"componentName": "Metrics",
				"logLevel": "WARN"
			},
			{
				"componentName": "Activity Processor",
				"logLevel": "WARN"
			},
			{
				"componentName": "Operator Control Panel",
				"logLevel": "WARN"
			},
			{
				"componentName": "Grid Management",
				"logLevel": "WARN"
			},
			{
				"componentName": "Job Manager",
				"logLevel": "WARN"
			}
		],
		"peerComponents": [
			{
				"componentId": "config",
				"name": "Config",
				"status": "Currently running"
			},
			{
				"componentId": "library_manager",
				"name": "Library Manager",
				"status": "Currently running"
			},
			{
				"componentId": "health",
				"name": "Health",
				"status": "Currently running"
			},
			{
				"componentId": "adapter_manager",
				"name": "Adapter Manager",
				"status": "Currently running"
			}
		]
	}
]

Status codes and messages

For more details about HTTP response codes, see HTTP response codes.

HTTP code	Message	Description
200	OK	Request succeeded
400		Invalid request An error occurred while adding the schedule.
401		Unauthorized
403		Forbidden The client is not permitted to access the resource
404		Not found No peer found with name
500		Internal server error