Get

/vastdbtable/aggregate/

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

tenant_id

integer

Filter by tenant. Specify tenant ID.

Minimum1

database_name

stringRequired

Getting list of objects by database_name

schema_name

stringRequired

Getting list of objects by schema_name

table_name

stringRequired

Getting list of objects by table_name

metrics

array of stringRequired

Comma-separated list of metrics to return for the dashboard. E.g. ?metrics=READ_BYTES,WRITE_COUNT. Additionally, following operations are supported for metrics: [+, -, *]. Useful to aggregate over a "custom/fake" metric value (sum / diff / product of real metrics). E.g. ?metrics=READ_BYTES+WRITE_BYTES,READ_COUNT-WRITE_COUNT. Which means take a sum of READ_BYTES and WRITE_BYTES, take a diff between READ_COUNT and WRITE_COUNT.

topn_by

string

What metric to do top N by. By default, sum of all the ?metrics is taken. Only applicable if sampling and/or sub-grouping is requested.

aggregate_function

string

Function to use when aggregating the results.

Valid values[ "sum", "avg" ]

Default"sum"

filters

string

URL-encoded JSON-string - actually an encoded mapping. Keys are column names. E.g. {"creation_time": [{"gt": "1727863200000"}, {"lt": "1729591200000"}], "atime": [{"gt": "1727776800000", "lt": "1729591200000"}]}'. Elements within a list per column are OR'ed, elements withing a map inside a list are AND'ed.

sample_per

string

Which column to sample per (X-axis).

sub_group_by

string

Which column to split the returning samples by (Y-axis).

samples_count

integer

Limit output amount of samples. Rest will be put into "__others__". When sampling per time, affects granularity with which samples are collected.

sub_groups_count

integer

Limit output amount of sub-groups. Rest will be put into "__others__".

Responses

200

OK

Expand All

object

JSON mapping of sub-groups for each sample. Ordered by aggregated metric value. When there was no sampling requested includes a single fake sample __all__. When there's more samples than can be displayed, includes __others__. Key is a category of a sample (sample's name). When sampled by continuous metric, name is a sample's <start_time>__<end_time> given as UNIX timestamps divided by dash. In this case, sample's width (end_time - start_time) depends on ?samples_count.

Example{ "262538880": { "/mnt/db": { "SETATTR": 56, "GETATTR": 1337 }, "/mnt/leet": { "SETATTR": 23, "GETATTR": 359 }, "__others__": { "SETATTR": 52, "GETATTR": 324 } }, "262537774": { "/mnt/spb": { "SETATTR": 23, "GETATTR": 359 }, "/mnt/archive": { "SETATTR": 56, "GETATTR": 1337 }, "__others__": { "SETATTR": 56, "GETATTR": 1337 } }, "__others__": { "/mnt/spb": { "SETATTR": 52, "GETATTR": 324 }, "/mnt/archive": { "SETATTR": 52, "GETATTR": 324 }, "__others__": { "SETATTR": 56, "GETATTR": 1337 } } }

property*

object (MetricsPerSubGroup) additionalProperties

JSON mapping of metrics for each sub-group in the sample. Ordered by aggregated metric value. When there was no sub-grouping requested includes a single fake sub-group __all__. When there's more sub-groups than can be displayed, includes "others". Key is a category of a sub-group (sample's name). When sampled by continuous metric, name is group's <start_time>__<end_time> given as UNIX timestamps divided by dash. In this case, sample's width (end_time - start_time) depends on ?groups_count.

Example{ "__all__": { "SETATTR": 52, "GETATTR": 1337 } }

property*

object (ValuePerMetric) additionalProperties

JSON mapping of value per each metric.

Example{ "SETATTR": 52.0, "GETATTR": 1337.0, "LOOKUP": 1337.0 }

property*

number additionalProperties

Shows historical data for the table