Get Peer Info

Retrieves the list of peers in your environment and additional information such as the peer name, status, operating system, and the host name.

This topic includes the following sections:

Request

HTTP method: GET

Request URL: https://<hostname>:<port>/baocdp/rest/info/peer

Note

Currently, you can only retrieve peer information for peers hosted on the CDP and HA-CDP.

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

Request body properties

This call does not require a request body.

Response

If successful, this method returns the following details about the CDP(s) and HA-CDP(s) on the grid.

Property	Description
name	Peer name
description	Peer description
osName	Name of the operating system
productVersion	Displays the platform version
hostName	Name of the host on which the peer is running

Example response JSON

{
   "peerInfoList": [
      {
           "name": "CDP",
           "status": "RUNNING",
           "osName": "Windows Server 2016",
           "productVersion": "8.2.00",
           "hostName": "hostname",
           "type": "Configuration Distribution Peer"
       },
       {
           "name": "AP1",
           "status": "RUNNING",
           "osName": "Windows Server 2012 R2",
           "productVersion": "8.2.00",
           "hostName": "hostname",
           "type": "Activity Peer"
       },
       {
           "name": "AP2",
           "status": "RUNNING",
           "osName": "Red Hat Enterprise Linux Server release 6.10 (Santiago)",
           "productVersion": "8.2.00",
           "hostName": "hostname",
           "type": "Activity Peer"
       },
       {
           "name": "LAP2",
           "status": "RUNNING",
           "osName": "SUSE Linux Enterprise Server 11 (x86_64)",
           "productVersion": "8.2.00",
           "hostName": "hostname",
           "type": "Lightweight Activity Peer"
       },
       {
           "name": "AP3",
           "status": "STOPPED",
           "osName": "",
           "hostName": "",
           "type": "Activity Peer"
       },
       {
           "name": "LAP1",
           "status": "STOPPED",
           "osName": "",
           "hostName": "",
           "type": "Lightweight Activity Peer"
       }
    ]
}

Status codes and error messages

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

HTTP code	Message	Description
200	OK
401		Unauthorized User is not authorized to access this API.
403		Forbidden Unable to get grid ID.
404		Not found When information is not retrieved from the database or unable to parse retrieved data.
500		Internal server error