Skip to main content

Update Hub Cluster (v4.0)

PUT 

/v4.0/api/tenants/:tenant_id/sites/:site_id/hubclusters/:hub_cluster_id

Update 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.

    hub_cluster_id stringrequired

    ID of the hub cluster.

Body

Details of the hub cluster to be created

    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.

  • Array [
  • 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.

Responses

Successful operation

Schema
    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.

  • Array [
  • 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.

Loading...