List Appliances per Cluster

Lists appliances related to a cluster.

If appliances are directly assigned to the cluster, they will be returned in response.
If a gateway is assigned to the cluster, the appliances that are available for assignment will be returned
(i.e. gateway appliances minus children appliances).

Example 1

Cluster schema:

  cluster1 gateways: [gw-1]
  ├─ cluster1_child1 [appliances: appliances.1, appliances.2]
  │  ├─ cluster1_child1_child1 [appliances: appliances.3]
  ├─ cluster1_child2
  • Cluster cluster1 has gateway gw-1 assigned.
  • gw-1 has 4 appliances connected to it: appliances.1, appliances.2, appliances.3, appliances.4.
  • appliances.1, appliances.2 are directly assigned to cluster1_child1.
  • appliances.3 is directly assigned to cluster1_child1_child1.

List appliances per Cluster then returns following values:

  • GET clusters/cluster1/appliances - [appliances.4] - the only available for assigment appliance.
  • GET clusters/cluster1_child1/appliances - [appliances.1, appliances.2] - directly assigned appliances.
  • GET clusters/cluster1_child1_child1/appliances - [appliances.3] - directly assigned appliance.
  • GET clusters/cluster1_child2/appliances - [] - no appliances nor gateway are directly assigned.

Example 2

Cluster schema:

  cluster2 gateways: [gw-2]
  ├─ cluster2_child1
  • Cluster cluster2 has gateway gw-2 assigned.
  • gw-2 has 4 appliances connected to it: appliances.1, appliances.2, appliances.3, appliances.4.

List appliances per Cluster then returns following values:

  • GET clusters/cluster2/appliances - [appliances.1, appliances.2, appliances.3, appliances.4] - the only available for assigment appliance.
  • GET clusters/cluster2_child1/appliances - [] - no appliances nor gateway are directly assigned.
Language
Credentials
Header
Click Try It! to start a request and see the response here!