Operations Hub Cluster (v4.0)
Operations to be performed on the hub cluster.
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.
- hub_cluster_id string required
ID of the hub cluster.
- application/json
Request Body
Details of the operations to be performed on the hub cluster.
- hub_element_id string
The device ID associated with the data center.
- id string
The IDs of the hub clusters.
- operation string
The operation performed on the hub cluster.
- peer_sites string[]
The sites associated with the data center cluster.
- 200
- 400
Successful operation
- application/json
- Schema
- Example (from 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 stringPossible values: [
FIRST
,SECOND
,THIRD
]HubClusterElementNumber: JsonIgnore(value = true)
hub_element_id stringHub Element Id
locked booleanLocked
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.
{
"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
}
Bad request
- application/json
- Schema
- Example (from schema)
- Example
Schema
_error ErrorResponse[]
Array [code stringmessage string]
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "HUB_CLUSTER_INVALID_OPERATION"
},
{
"code": "HUB_ELEMENT_ID_NULL_OR_EMPTY"
},
{
"code": "HUB_CLUSTER_OPERATION_SPOKE_SITES_CANNOT_BE_EMPTY"
},
{
"code": "HUB_CLUSTER_OR_STATUS_NOT_FOUND"
},
{
"code": "HUB_CLUSTER_EMPTY"
},
{
"code": "HUB_CLUSTER_ELEMENT_NOT_LOCKED"
},
{
"code": "HUB_ELEMENT_NOT_PRESENT_IN_HUB_CLUSTER"
},
{
"code": "HUB_CLUSTER_DOES_NOT_CATER_TO_SPECIFIED_SPOKE_SITES"
},
{
"code": "HUB_CLUSTER_NEW_HUB_ELEMENT_NOT_FOUND"
},
{
"code": "HUB_CLUSTER_ELEMENT_DOES_NOT_CATER_TO_SPECIFIED_SPOKE_SITES"
}
]
}
}