Get Hub Clusters (v4.0)

GET 
/v4.0/api/tenants/:tenant_id/sites/:site_id/hubclusters

List all the hub clusters.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

site_id stringrequired

ID of the site. More details on the site can be retrieved by querying the sites API.

Responses

200

Successful operation

application/json

Schema

Schema

count int32

The actual count.

id string

The ID.

tenant_id string

The tenant ID.

items HubClusterV4[]
Array [
default_cluster boolean
List the details of the default cluster.
description
Description of the default cluster.
elements HubClusterElement[]
Details of the elements in the cluster.
Array [
hubClusterElementNumber string
Possible values: [FIRST, SECOND, THIRD]
HubClusterElementNumber: JsonIgnore(value = true)
hub_element_id string
Hub Element Id
locked boolean
Locked
]
id string
The ID of the cluster.
name stringrequired
The name of the cluster.
peer_sites string[]required
The sites associated with the data center cluster.
site_count_alarm_threshold integer
The count threshold of the alarms for the sites.
tags string[]
A information field that can be added to identify the hub cluster.
]

Example (from schema)

{
  "count": 0,
  "id": "string",
  "tenant_id": "string",
  "items": [
    {
      "default_cluster": true,
      "elements": [
        {
          "hubClusterElementNumber": "FIRST",
          "hub_element_id": "string",
          "locked": true
        }
      ],
      "id": "string",
      "name": "string",
      "peer_sites": [
        "string"
      ],
      "site_count_alarm_threshold": 0,
      "tags": [
        "string"
      ]
    }
  ]
}

Loading...