Get

/monitors/ad_hoc_query/

This endpoint queries VMS for analytics.

Security

HTTP

Type basic

Basic authentication using VMS user name and password

API Key: ApiToken

Header parameter nameApiToken

Send current valid API token in an Authorization header with format Api-Token .

Query parameters

object_type

stringRequired

The type of object to monitor.

Valid values[ "cluster", "cnode", "dnode", "nvram", "replicationstream", "ssd" ]

from_time

string

Start time of report. e.g. 2021-01-15T13:41:52Z

to_time

string

End time of report. e.g. 2021-01-15T13:41:52Z

time_frame

string

Time frame to report. Specify as an integer followed by 'm' (minutes) 'h' (hours), 'D' (days) ,'W' (weeks) or 'M' (months) 'Y' (years). e.g. 10m

object_ids

array of integer

Specify a list of IDs of objects of the specified object_type to filter the report on those specific objects.

prop_list

array of string

A list of metrics to query. To get the full list of metrics, use GET /metrics/.

granularity

string

Data granularity: seconds (raw), minutes (five minute aggregated samples), hours (hourly aggregated samples), or days (daily aggregated samples)

aggregation

string

If granularity is minutes, hours or days, the data is aggregated. This parameter selects which aggregation function to use.

Valid values[ "avg", "min", "max", "latency_weighted_average", "stddev", "sum" ]

format_data

boolean

Defaultfalse

Responses

200

Expand All

object

object_ids

object

list of object ids that appears in the query results

prop_list

object

list of metrics that appears in the result

data

object

list of data samples, each sample in form of [timestamp, obj_id, *data]

Query Analytics with Ad Hoc Query Parameters