Spectra Logic

1-800-833-1132 : 1-303-449-6400

Get Nodes

Description

Gets information about all nodes in a single BlackPearl system instance or name space.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/node[?last_page]​[&page_length={32‑bit integer}]​[&page_offset={32‑bit integer}]​[&page_start_marker={string}]

Request Parameters

Parameter	Description	Required
last_page	If included, only the last page of results is returned.	no
page_length	The maximum number of nodes to list. Default: all items after page_offset.	no
page_offset	The starting point for the first node to list. Default: 0.	no
page_start_marker	The UUID or other unique attribute for the item just before the first item to list. Notes:   § Specifying both page_offset and page_start_marker causes an error. § If neither page_offset, nor page_start_marker are specified, the page_offset default is used.	no

Responses

Response Elements

<Data>
   <Node>
      <DataPathHttpPort>{16-bit integer}</DataPathHttpPort>
      <DataPathHttpsPort>{16-bit integer}</DataPathHttpsPort>
      <DataPathIpAddress>{string}</DataPathIpAddress>
      <DnsName>{string}</DnsName>
      <Id>{string}</Id>
      <LastHeartbeat>{YYYY-MM-DDThh:mm:ss.xxxZ}</LastHeartbeat>
      <Name>{string}</Name>
      <SerialNumber>{string}</SerialNumber>
   </Node>
   ...
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	A container for the response.
Node	A container for information about one node.
DataPathHttpPort	The port used for HTTP. If not present in the response, then HTTP access is not configured.
DataPathHttpsPort	The port used for HTTPS. If not present in the response, then HTTPS access is not configured.
DataPathIpAddress	The IPv4 address for the BlackPearl data path.
DnsName	The domain name for the BlackPearl system.
Id	The UUID for the BlackPearl system.
LastHeartbeat	The date and time that the system last sent a heartbeat in the format YYYY-MM-DDThh:mm:ss.xxxZ.
Name	The name for the BlackPearl system.
SerialNumber	The serial number for the BlackPearl system.

Example

Sample Request

This request lists information about all nodes.

GET http://blackpearl-hostname/_rest_/node/ HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>
   <Node>
      <DataPathHttpPort/>
      <DataPathHttpsPort>443</DataPathHttpsPort>
      <DataPathIpAddress>10.1.16.1</DataPathIpAddress>
      <DnsName/>
      <Id>48db59bd-cd5d-481a-93a7-15caa0a8ab43</Id>
      <LastHeartbeat>2015-10-13 14:42:54.378</LastHeartbeat>
      <Name>EngineeringBP</Name>
      <SerialNumber>5003048001fff43f</SerialNumber>
   </Node>
   ...
</Data>