Skip to main content

Query Spoke Clusters (v2.0)

Query all the spoke clusters.

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.

Request Body

Query Details for the spokecluster

  • aggregate Aggregate

    The aggregate number of 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 clusters deleted for a time frame.

  • group_by string[]

    Group By

  • id string

    List the 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

    The limit.

  • query_params object
  • retrieved_fields string[]

    Retrieve information from a field.

  • retrieved_fields_mask boolean

    List the 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 SpokeClusterQueryFilter[]
  • Array [
  • advertisement_interval double required

    Lists the intervals in which the active device advertises its status to the backup.

  • description

    The cluster description.

  • id string

    The ID of the site.

  • name string required

    Name of the cluster.

  • preempt boolean required

    Indicates if preemption is required or not.

  • tags string[]

    Displays the details about the tags or labels applied to the clusters.

  • ]