Yandex.Cloud
  • Services
  • Why Yandex.Cloud
  • Pricing
  • Documentation
  • Contact us
Get started
Yandex Monitoring
  • Getting started
  • Step-by-step instructions
    • All instructions
    • Working with metrics
      • Getting a list of metrics
      • Downloading metrics
      • Writing custom metrics
      • Export metrics in Prometheus format
    • Working with dashboards
      • Creating dashboards
      • Copying dashboards
      • Adding widgets to a dashboard
      • Deleting widgets from a dashboard
      • Deleting dashboards
    • Working with alerts
      • Creating alerts
      • Creating notification channels
      • Deleting alerts
  • Concepts
    • Overview
    • Data model
    • Visualization
      • Overview
      • Query string
      • Widgets
      • Dashboards
    • Query language
    • Alerting
    • Data decimation
    • Deleting expired metrics (TTL)
    • Quotas and limits
  • Access management
  • Pricing policy
    • Current pricing policy
    • Archive
      • Policy before October 1, 2020
  • API reference
    • Authentication in the API
    • REST
      • Overview
      • MetricsData
        • Overview
        • read
        • write
        • prometheusMetrics
      • MetricsMeta
        • Overview
        • listLabelKeys
        • listLabelValues
        • listMetricNames
        • listMetrics
  • Questions and answers
  1. API reference
  2. REST
  3. MetricsMeta
  4. listMetrics

Method listMetrics

  • HTTP request
  • Query parameters
  • Response

Retrieves the list of metrics.

HTTP request

GET https://monitoring.api.cloud.yandex.net/monitoring/v2/metrics

Query parameters

Parameter Description
folderId Required. ID of the folder that the metric belongs to. The maximum string length in characters is 50.
selectors Metric selectors.
pageSize Maximum number of metrics in response. 0 means default page size = 30, maximum page size = 10000.
pageToken Page token. To get the next page of results, set pageToken to the nextPageToken returned by a previous list request.

Response

HTTP Code: 200 - OK

{
  "metrics": [
    {
      "name": "string",
      "labels": "object",
      "type": "string"
    }
  ],
  "nextPageToken": "string"
}
Field Description
metrics[] object

List of metrics.

metrics[].
name
string

Name of the metric.

metrics[].
labels
object

Metric labels as key:value pairs.

metrics[].
type
string

Type of the metric.

  • DGAUGE: Gauge with fractional values.
  • IGAUGE: Gauge with integer values.
  • COUNTER: Counter.
  • RATE: Rate.
nextPageToken string

This token allows you to get the next page of results for list requests.

In this article:
  • HTTP request
  • Query parameters
  • Response
Language
Careers
Privacy policy
Terms of use
© 2021 Yandex.Cloud LLC