Get Hub Cluster Status (v4.0)

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

Get the state of the hub cluster.

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.

id stringrequired

ID of the hub cluster.

Responses

200

Successful operation

application/json

Schema

Schema

cluster_state string

Possible values: [cluster_update_in_progress, cluster_update_completed, vpn_update_in_progress, vpn_update_ack_pending]

The cluster state.

elements HubClusterStateElement[]
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
peer_sites string[]
Peer Sites
]
id string

The ID of the cluster.

vpns_added int32

The number of vpns added to the cluster.

vpns_deleted int32

The number of vpns deleted in the cluster.

Example (from schema)

{
  "cluster_state": "cluster_update_in_progress",
  "elements": [
    {
      "hubClusterElementNumber": "FIRST",
      "hub_element_id": "string",
      "locked": true,
      "peer_sites": [
        "string"
      ]
    }
  ],
  "id": "string",
  "vpns_added": 0,
  "vpns_deleted": 0
}

404

Hub Cluster not found

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Loading...