Get Hub Clusters (v4.0)
List all the hub clusters.
Path Parameters
- tenant_id string required
The tenant ID.
- site_id string required
ID of the site. More details on the site can be retrieved by querying the sites API.
Responses
- 200
Successful operation
- application/json
- Schema
- Example (from schema)
Schema
- count int32
The number of responses.
- id string
The ID of the response.
- tenant_id string
items HubClusterV4[]
Array [default_cluster booleanList the details of the default cluster.
descriptionDescription of the default cluster.
elements HubClusterElement[]
Details of the elements in the cluster.
Array [hubClusterElementNumber stringPossible values: [
FIRST
,SECOND
,THIRD
]HubClusterElementNumber: JsonIgnore(value = true)
hub_element_id stringHub Element Id
locked booleanLocked
]id stringThe ID of the cluster.
name string requiredThe name of the cluster.
peer_sites string[] requiredThe sites associated with the data center cluster.
site_count_alarm_threshold integerThe count threshold of the alarms for the sites.
tags string[]A information field that can be added to identify the hub cluster.
]
{
"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...