Get Spoke Cluster Status (v2.0)

GET 
/v2.0/api/tenants/:tenant_id/sites/:site_id/spokeclusters/:spoke_cluster_id/status

Get the status of the spoke 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.

spoke_cluster_id stringrequired

ID of the spoke cluster.

Responses

200

Successful Operation

application/json

Schema

Schema

cluster_members ClusterMember[]
Lists the members of the spoke cluster.
Array [
element_id string
Element Id
status string
Possible values: [init, active, backup, unknown]
Status
]
id string

The ID of the spoke cluster.

switch_over_events SwitchOverEvent[]
List the spoke cluster switch over event history.
Array [
active boolean
Active
adjustments Adjustment[]
Adjustments
Array [
adjustment int32
Adjustment
kind string
Kind
name string
Name
]
cluster_events ClusterEvent[]
Cluster Events
Array [
adjustments Adjustment[]
Adjustments
Array [
adjustment int32
Adjustment
kind string
Kind
name string
Name
]
effective_priority int32
Effective Priority
peer_connected boolean
Peer Connected
time int64
Time
]
effective_priority int32
Effective Priority
element_id string
Element Id
peer_connected boolean
Peer Connected
switch_over_time int64
Switch Over Time
]

Example (from schema)

{
  "cluster_members": [
    {
      "element_id": "string",
      "status": "init"
    }
  ],
  "id": "string",
  "switch_over_events": [
    {
      "active": true,
      "adjustments": [
        {
          "adjustment": 0,
          "kind": "string",
          "name": "string"
        }
      ],
      "cluster_events": [
        {
          "adjustments": [
            {
              "adjustment": 0,
              "kind": "string",
              "name": "string"
            }
          ],
          "effective_priority": 0,
          "peer_connected": true,
          "time": 0
        }
      ],
      "effective_priority": 0,
      "element_id": "string",
      "peer_connected": true,
      "switch_over_time": 0
    }
  ]
}

Loading...