GET v1/bunits/{bunitId}/consumers/{consumerId}/node/nodegroups/available

Get all available node groups
Does not include node groups already associated with the backup node

Request Information

URI Parameters

NameDescriptionTypeAdditional information
bunitId integer

Required

consumerId integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of NodeGroup
NameDescriptionTypeAdditional information
Name Name of the machine (TCPName) (SP information)
string

None.

Id A unique ID for the object.
integer

Read-only.

CreatedDate Time and date the object was created.
date

Read-only.

ArchivedDate Time and date the object was or is going to be archived.

Unarchived objects have no value in ArchivedDate
date

Read-only.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml, text/xml

Sample:
<ArrayOfNodeGroup xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <NodeGroup>
    <Id>2</Id>
    <CreatedDate>2024-05-20T18:15:37.0298605+02:00</CreatedDate>
    <ArchivedDate>2024-05-20T18:15:37.0298605+02:00</ArchivedDate>
    <Name>sample string 1</Name>
  </NodeGroup>
  <NodeGroup>
    <Id>2</Id>
    <CreatedDate>2024-05-20T18:15:37.0298605+02:00</CreatedDate>
    <ArchivedDate>2024-05-20T18:15:37.0298605+02:00</ArchivedDate>
    <Name>sample string 1</Name>
  </NodeGroup>
</ArrayOfNodeGroup>