API Reference

/monitoring/metrics

get
https://{server}/monitoring/metrics

Returns the metrics data

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
required

Monitoring entity type

Allowed:
uuid

The ID of the DB Service. This parameter is required when entity-type is one of DB Engines

uuid

The ID of the service's instance. This parameter is required when entity-type is one of DB Engines

uuid

The ID of the Compute Resource(NODE). This parameter is required when entity-type is NODE

string

Start timestamp in prometheus date-time format yyyy-MM-dd'T'HH:mm:ss.SSSSSSSSS'Z'

string

End timestamp in prometheus date-time format yyyy-MM-dd'T'HH:mm:ss.SSSSSSSSS'Z'

string

Specifies the frequency at which data points are sampled or aggregated within the specified time range

string
enum
Defaults to PROMETHEUS

Metric Source (Prometheus/Victoria metrics)

Allowed:
aggregation-types
array of objects

List of aggregation types to be performed on the metric

aggregation-types
string

Specifies the time window for the aggregation functions. Use a string with a time unit, e.g., '1m', '5m', '1h'. Maximum valid unit of time - day (d). Minimum valid unit of time - min (m).

string

Name of chart that contains metrics

boolean

If true, returns all available aggregation types for the metrics, overriding any specific aggregation-types provided in the query.

Headers
uuid
required

Tenant ID

string
required

Authorization Token

Responses

Updated about 2 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago