Skip to main content

Query Spoke Clusters (v2.0)

POST 

/v2.0/api/tenants/:tenant_id/spokeclusters/query

Query the details for the spoke cluster.

Request

Path Parameters

    tenant_id stringrequired

    The tenant ID.

Body

Query Details for the spokecluster

    aggregate Aggregate

    The aggregate number of clusters that match the query parameters.

    field string

    Field

    operator string

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

    Operator

    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.

Responses

Successful Operation

Schema
    count int32

    The actual count.

    deleted_count int64

    The deleted number.

    deleted_ids string[]

    The deleted IDs.

    description

    Description of the query. Max size = 256.

    id string

    The ID.

    next_query object

    Details of the next query.

    tenant_id string

    The tenant ID.

    total_count int64

    Total number.

    items SpokeClusterQueryFilterResponse[]
  • Array [
  • advertisement_interval double

    List 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

    Name of the cluster.

    preempt boolean

    Indicates if preemption is required or not.

    site_id string

    Site Id

    tags string[]

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

  • ]
Loading...