Create Hub Cluster (v4.0)
POST/v4.0/api/tenants/:tenant_id/sites/:site_id/hubclusters
Create a hub cluster.
Request
Path Parameters
The tenant ID.
ID of the site. More details on the site can be retrieved by querying the sites API.
- application/json
Body
Details of the hub cluster to be created
- Array [
- ]
List the details of the default cluster.
Description of the default cluster.
elements HubClusterElement[]
Details of the elements in the cluster.
Possible values: [FIRST
, SECOND
, THIRD
]
HubClusterElementNumber: JsonIgnore(value = true)
Hub Element Id
Locked
The ID of the cluster.
The name of the cluster.
The sites associated with the data center cluster.
The count threshold of the alarms for the sites.
A information field that can be added to identify the hub cluster.
Responses
- 200
- 400
Successful operation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
List the details of the default cluster.
Description of the default cluster.
elements HubClusterElement[]
Details of the elements in the cluster.
Possible values: [FIRST
, SECOND
, THIRD
]
HubClusterElementNumber: JsonIgnore(value = true)
Hub Element Id
Locked
The ID of the cluster.
The name of the cluster.
The sites associated with the data center cluster.
The count threshold of the alarms for the sites.
A information field that can be added to identify the hub cluster.
{
"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"
]
}
Bad request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
_error ErrorResponse[]
The error code.
The error message.
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "HUB_CLUSTER_NAME_NULL_OR_EMPTY"
},
{
"code": "HUB_CLUSTER_NAME_EXCEEDS_LIMIT"
},
{
"code": "DESCRIPTION_EXCEEDS_LIMIT"
},
{
"code": "INVALID_TAG"
},
{
"code": "INVALID_HUB_SITE"
},
{
"code": "HUB_CLUSTER_ELEMENT_PRESENT"
},
{
"code": "DEFAULT_HUB_CLUSTER_EXISTS"
},
{
"code": "HUB_CLUSTER_NAME_NOT_UNIQUE"
},
{
"code": "HUB_CLUSTER_COUNT_IN_HUB_SITE_EXCEEDED"
},
{
"code": "DUPLICATE_SPOKE_SITES_PRESENT"
},
{
"code": "INVALID_PEER_SITES_PRESENT"
},
{
"code": "SOME_SPOKE_SITES_ALREADY_MAPPED_TO_ANOTHER_CLUSTER"
},
{
"code": "INVALID_VALUE_RANGE"
}
]
}
}