Query Spoke Clusters (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/sites/:site_id/spokeclusters/query

Query all the spoke clusters.

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.

application/json

Body

Query Details for the spokecluster

aggregate Aggregate

The aggregate number of clusters that match the query parameters.

data AggregateData[]

The details of the aggregate data.

Array [

value number

Value of the aggregate data.

view object

View the aggregate date.

]

field string

Field

name string

The name of the query response.

operator string

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

Operator

statistic string

QoS application aggregate statistics.

unit string

The unit.

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

200

Successful Operation

application/json

Schema

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 SpokeClusterQueryFilter[]
Array [
advertisement_interval doublerequired
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 stringrequired
Name of the cluster.
preempt booleanrequired
Indicates if preemption is required or not.
tags string[]
Displays the details about the tags or labels applied to the clusters.
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "tenant_id": "string",
  "total_count": 0,
  "items": [
    {
      "advertisement_interval": 0,
      "id": "string",
      "name": "string",
      "preempt": true,
      "tags": [
        "string"
      ]
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "BAD_REQUEST"
      }
    ]
  }
}

Loading...