Skip to main content

Query Hub Clusters (v4.0)

Query hub clusters.

Path Parameters
  • tenant_id string required

    The tenant ID.

Request Body

Details of the hub cluster to be created

  • aggregate Aggregate

    The aggregate number of hub clusters that match the query parameters.

  • field string

    The field value.

  • operator string

    Possible values: [max, count, min, avg, sum]

    The operator values.

  • dest_page int32

    The destination page.

  • getDeleted boolean

    The number of hub clusters deleted for a time frame.

  • group_by string[]

    Group the hub clusters for the query.

  • id string

    List the hub clusters by ID.

  • last_query_ts int64

    Return the ID of a specified query in the current session.

  • limit int32

    The query limit.

  • next_query object

    List the next query.

  • query_params object
  • retrieved_fields string[]

    Retrieve information from a field.

  • retrieved_fields_mask boolean

    List the marked fields to query.

  • sort_params object
  • total_count int64

    The total number of query parameters.


Successful operation

  • count int32

    The count of the query list.

  • deleted_count int64

    The deleted number of queries.

  • deleted_ids string[]

    The deleted query IDs.

  • description

    Description of the query. Max size = 256.

  • id string

    The ID.

  • next_query object

    Details of the next query.

  • tenant_id string
  • total_count int64

    Total number of queries.

  • items HubClusterQueryFilterV4[]
  • Array [
  • 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


  • ]
  • id string

    The ID of the cluster.

  • name string

    The name of the cluster.

  • peer_sites string[]

    The sites associated with the data center cluster.

  • site_count_alarm_threshold integer

    The count threshold of the alarms for the sites.

  • site_id string

    The ID of the site.

  • tags string[]

    A information field that can be added to identify the hub cluster.

  • ]