Get Hub Clusters (v4.0)
GET/sdwan/v4.0/api/sites/:site_id/hubclusters
List all the hub clusters.
Request
Path Parameters
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
- Example (from schema)
Schema
- Array [
- Array [
- ]
- ]
count int32
The actual count.
id string
The ID.
items HubClusterV4[]
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.
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.
{
"count": 0,
"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...