Get

/monitors/topn/

This endpoint queries VMS for top performer data. It can return performance metrics for the most active client users, views, client hosts, vips, vip pools and cnodes.

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

key

stringRequired

Filters results by category of performers. Supported for users, clients and views only.

Valid values[ "user", "client", "view" ]

type

stringRequired

Filters results by a specified performance metric

Valid values[ "bw", "iops", "md_iops" ]

count

integer

The maximum number of top performers in each category to return in the response

timestamp

string

The timestamp for which to display data. For example, 2023-12-06T13:10:03Z. If not passed, the most recent sampling is returned.

Responses

200

object

Query Top Performer Data