Поделиться через


Metrics - List

Списки значения метрик для ресурса.

GET https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/metrics?api-version=2023-10-01
GET https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/metrics?timespan={timespan}&interval={interval}&metricnames={metricnames}&aggregation={aggregation}&top={top}&orderby={orderby}&$filter={$filter}&resultType={resultType}&api-version=2023-10-01&metricnamespace={metricnamespace}&AutoAdjustTimegrain={AutoAdjustTimegrain}&ValidateDimensions={ValidateDimensions}&rollupby={rollupby}

Параметры URI

Имя В Обязательно Тип Описание
resourceUri
path True

string

Идентификатор ресурса.

api-version
query True

string

Версия API, используемая для данной операции.

$filter
query

string

$filter используется для уменьшения набора возвращаемых данных метрик.
Пример
Метрика содержит метаданные A, B и C.
— возвращает все временные ряды C, где A = a1 и B = b1 или b2
$filter=A eq 'a1' and B eq 'b1' or Bq 'b2' and C eq '*'
— Недопустимый вариант:
$filter=A eq 'a1' and Bq 'b1' and C eq '*' или B = 'b2'
Это недопустимо, так как логический оператор или не может разделить два разных имени метаданных.
— Возвращает все временные ряды, где A = a1, B = b1 и C = c1:
$filter=A eq 'a1' and B eq 'b1' and C eq 'c1'
— возвращает все временные ряды, где A = a1
$filter=A eq 'a1' and B eq '' and C eq ''.

aggregation
query

string

Список типов агрегирования (разделенных запятыми) для получения. Примеры: среднее, минимальное, максимальное

AutoAdjustTimegrain
query

boolean

Если задано значение true, если переданный интервал времени не поддерживается этой метрикой, API вернет результат с использованием ближайшего поддерживаемого интервала времени. Если задано значение false, возвращается ошибка для недопустимых параметров интервала времени. Значение по умолчанию — false.

interval
query

string

Интервал (т. е. timegrain) запроса в формате длительности ISO 8601. По умолчанию — PT1M. Особый случай для значения FULL, которое возвращает одну точку данных для всего запрошенного периода времени. Примеры: PT15M, PT1H, P1D, FULL

metricnames
query

string

Имена метрик (разделенных запятыми) для извлечения.

metricnamespace
query

string

Пространство имен метрик, в котором находятся метрики.

orderby
query

string

Агрегирование, используемое для сортировки результатов и направление сортировки. Можно указать только один заказ. Примеры: sum asc

resultType
query

ResultType

Сокращает набор собираемых данных. Допустимый синтаксис зависит от операции. Дополнительные сведения см. в описании операции.

rollupby
query

string

Имена измерений для свертки результатов. Например, если вы хотите видеть только значения метрик с фильтром, таким как "City eq Seattle or City eq Tacoma", но не хотите видеть отдельные значения для каждого города, можно указать "RollUpBy=City", чтобы просмотреть результаты для Сиэтла и Tacoma, сложенные в один раз.

timespan
query

string

Временной диапазон запроса. Это строка в следующем формате "startDateTime_ISO/endDateTime_ISO".

top
query

integer

int32

Максимальное количество записей, извлекаемых для каждого идентификатора ресурса в запросе. Допустимо, только если указан фильтр. Значение по умолчанию равно 10.

ValidateDimensions
query

boolean

Если задано значение false, недопустимые значения параметров фильтра будут игнорироваться. Если задано значение true, возвращается ошибка для недопустимых параметров фильтра. По умолчанию используется значение «true».

Ответы

Имя Тип Описание
200 OK

Response

Успешный запрос на получение списка значений метрик.

Other Status Codes

ErrorResponse

Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

Get Metric for data
Get Metric for metadata
Get Metric with error

Get Metric for data

Sample Request

GET https://management.azure.com/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default/providers/Microsoft.Insights/metrics?timespan=2021-04-20T09:00:00.000Z/2021-04-20T14:00:00.000Z&interval=PT6H&metricnames=BlobCount,BlobCapacity&aggregation=average,minimum,maximum&top=5&orderby=average asc&$filter=Tier eq '*'&api-version=2023-10-01&metricnamespace=Microsoft.Storage/storageAccounts/blobServices&AutoAdjustTimegrain=True&ValidateDimensions=False

Sample Response

{
  "cost": 598,
  "timespan": "2021-04-20T09:00:00Z/2021-04-20T14:00:00Z",
  "interval": "PT1H",
  "value": [
    {
      "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default/providers/Microsoft.Insights/metrics/BlobCount",
      "type": "Microsoft.Insights/metrics",
      "name": {
        "value": "BlobCount",
        "localizedValue": "Blob Count"
      },
      "displayDescription": "The number of blob objects stored in the storage account.",
      "unit": "Count",
      "timeseries": [
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Hot"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-04-20T09:00:00Z",
              "average": 7,
              "minimum": 7,
              "maximum": 7
            },
            {
              "timeStamp": "2021-04-20T10:00:00Z",
              "average": 7,
              "minimum": 7,
              "maximum": 7
            },
            {
              "timeStamp": "2021-04-20T11:00:00Z",
              "average": 7,
              "minimum": 7,
              "maximum": 7
            },
            {
              "timeStamp": "2021-04-20T12:00:00Z",
              "average": 7,
              "minimum": 7,
              "maximum": 7
            },
            {
              "timeStamp": "2021-04-20T13:00:00Z",
              "average": 7,
              "minimum": 7,
              "maximum": 7
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Standard"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-04-20T09:00:00Z",
              "average": 2,
              "minimum": 2,
              "maximum": 2
            },
            {
              "timeStamp": "2021-04-20T10:00:00Z",
              "average": 2,
              "minimum": 2,
              "maximum": 2
            },
            {
              "timeStamp": "2021-04-20T11:00:00Z",
              "average": 2,
              "minimum": 2,
              "maximum": 2
            },
            {
              "timeStamp": "2021-04-20T12:00:00Z",
              "average": 2,
              "minimum": 2,
              "maximum": 2
            },
            {
              "timeStamp": "2021-04-20T13:00:00Z",
              "average": 2,
              "minimum": 2,
              "maximum": 2
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Cool"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-04-20T09:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T10:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T11:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T12:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T13:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Archive"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-04-20T09:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T10:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T11:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T12:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T13:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Untiered"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-04-20T09:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T10:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T11:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T12:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T13:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            }
          ]
        }
      ],
      "errorCode": "Success"
    },
    {
      "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default/providers/Microsoft.Insights/metrics/BlobCapacity",
      "type": "Microsoft.Insights/metrics",
      "name": {
        "value": "BlobCapacity",
        "localizedValue": "Blob Capacity"
      },
      "displayDescription": "The amount of storage used by the storage account’s Blob service in bytes.",
      "unit": "Bytes",
      "timeseries": [
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Standard"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-04-20T09:00:00Z",
              "average": 621492,
              "minimum": 621492,
              "maximum": 621492
            },
            {
              "timeStamp": "2021-04-20T10:00:00Z",
              "average": 621492,
              "minimum": 621492,
              "maximum": 621492
            },
            {
              "timeStamp": "2021-04-20T11:00:00Z",
              "average": 621492,
              "minimum": 621492,
              "maximum": 621492
            },
            {
              "timeStamp": "2021-04-20T12:00:00Z",
              "average": 621492,
              "minimum": 621492,
              "maximum": 621492
            },
            {
              "timeStamp": "2021-04-20T13:00:00Z",
              "average": 621492,
              "minimum": 621492,
              "maximum": 621492
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Hot"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-04-20T09:00:00Z",
              "average": 4733,
              "minimum": 4733,
              "maximum": 4733
            },
            {
              "timeStamp": "2021-04-20T10:00:00Z",
              "average": 4733,
              "minimum": 4733,
              "maximum": 4733
            },
            {
              "timeStamp": "2021-04-20T11:00:00Z",
              "average": 4733,
              "minimum": 4733,
              "maximum": 4733
            },
            {
              "timeStamp": "2021-04-20T12:00:00Z",
              "average": 4733,
              "minimum": 4733,
              "maximum": 4733
            },
            {
              "timeStamp": "2021-04-20T13:00:00Z",
              "average": 4733,
              "minimum": 4733,
              "maximum": 4733
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Archive"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-04-20T09:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T10:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T11:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T12:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T13:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Untiered"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-04-20T09:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T10:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T11:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T12:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T13:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Cool"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-04-20T09:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T10:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T11:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T12:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            },
            {
              "timeStamp": "2021-04-20T13:00:00Z",
              "average": 0,
              "minimum": 0,
              "maximum": 0
            }
          ]
        }
      ],
      "errorCode": "Success"
    }
  ],
  "namespace": "microsoft.storage/storageaccounts/blobservices",
  "resourceregion": "westus2"
}

Get Metric for metadata

Sample Request

GET https://management.azure.com/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default/providers/Microsoft.Insights/metrics?timespan=2017-04-14T02:20:00Z/2017-04-14T04:20:00Z&$filter=Tier eq '*'&api-version=2023-10-01&metricnamespace=Microsoft.Storage/storageAccounts/blobServices

Sample Response

{
  "timespan": "2021-04-15T02:18:00Z/2021-04-22T02:18:00Z",
  "interval": "PT1H",
  "value": [
    {
      "id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default/providers/Microsoft.Insights/metrics/BlobCount",
      "type": "Microsoft.Insights/metrics",
      "name": {
        "value": "BlobCount",
        "localizedValue": "Blob Count"
      },
      "displayDescription": "The number of blob objects stored in the storage account.",
      "unit": "Count",
      "timeseries": [
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Cool"
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Archive"
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Standard"
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Untiered"
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "tier",
                "localizedValue": "tier"
              },
              "value": "Hot"
            }
          ]
        }
      ]
    }
  ],
  "namespace": "microsoft.storage/storageaccounts/blobservices",
  "resourceregion": "westus2"
}

Get Metric with error

Sample Request

GET https://management.azure.com/subscriptions/ac41e21f-afd6-4a79-8070-f01eba278f97/resourceGroups/todking/providers/Microsoft.DocumentDb/databaseAccounts/tk-cosmos-mongo/providers/Microsoft.Insights/metrics?timespan=2021-06-07T21:51:00Z/2021-06-08T01:51:00Z&interval=FULL&metricnames=MongoRequestsCount,MongoRequests&aggregation=average&api-version=2023-10-01&metricnamespace=microsoft.documentdb/databaseaccounts&AutoAdjustTimegrain=True&ValidateDimensions=False

Sample Response

{
  "cost": 239,
  "timespan": "2021-06-07T21:51:00Z/2021-06-08T01:51:00Z",
  "interval": "PT4H",
  "value": [
    {
      "id": "/subscriptions/ac41e21f-afd6-4a79-8070-f01eba278f97/resourceGroups/todking/providers/Microsoft.DocumentDb/databaseAccounts/tk-cosmos-mongo/providers/Microsoft.Insights/metrics/MongoRequestsCount",
      "type": "Microsoft.Insights/metrics",
      "name": {
        "value": "MongoRequestsCount",
        "localizedValue": "(deprecated) Mongo Request Rate"
      },
      "unit": "CountPerSecond",
      "timeseries": [],
      "errorMessage": "Sampling type is not found. Metric:CosmosDBCustomer,AzureMonitor,MongoRequests, SamplingType:NullableAverage.",
      "errorCode": "InvalidSamplingType"
    },
    {
      "id": "/subscriptions/ac41e21f-afd6-4a79-8070-f01eba278f97/resourceGroups/todking/providers/Microsoft.DocumentDb/databaseAccounts/tk-cosmos-mongo/providers/Microsoft.Insights/metrics/MongoRequests",
      "type": "Microsoft.Insights/metrics",
      "name": {
        "value": "MongoRequests",
        "localizedValue": "Mongo Requests"
      },
      "displayDescription": "Number of Mongo Requests Made",
      "unit": "Count",
      "timeseries": [
        {
          "metadatavalues": [],
          "data": [
            {
              "timeStamp": "2021-06-07T21:51:00Z",
              "average": 0
            }
          ]
        }
      ],
      "errorCode": "Success"
    }
  ],
  "namespace": "microsoft.documentdb/databaseaccounts",
  "resourceregion": "westus2"
}

Определения

Имя Описание
ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorResponse

Сообщение об ошибке

LocalizableString

Локализуемый строковый класс.

MetadataValue

Представляет значение метаданных метрики.

Metric

Результирующий результат запроса.

MetricUnit

Единица измерения метрики.

MetricValue

Представляет значение метрики.

Response

Ответ на запрос метрик.

ResultType

Уменьшает набор собираемых данных. Допустимый синтаксис зависит от операции. Дополнительные сведения см. в описании операции.

TimeSeriesElement

Тип результата временных рядов. В данном случае дискриминатором всегда является TimeSeries.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.

type

string

Тип дополнительных сведений.

ErrorResponse

Сообщение об ошибке

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.

code

string

Код ошибки.

details

ErrorResponse[]

Сведения об ошибке.

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

LocalizableString

Локализуемый строковый класс.

Имя Тип Описание
localizedValue

string

Отображаемое имя.

value

string

Инвариантное значение.

MetadataValue

Представляет значение метаданных метрики.

Имя Тип Описание
name

LocalizableString

Имя метаданных.

value

string

Значение метаданных.

Metric

Результирующий результат запроса.

Имя Тип Описание
displayDescription

string

Подробное описание этой метрики.

errorCode

string

"Успешно" или сведения об ошибке при сбое запросов для этой метрики.

errorMessage

string

Возникло сообщение об ошибке, запрашивающее эту конкретную метрику.

id

string

Идентификатор метрики.

name

LocalizableString

Имя и отображаемое имя метрики, т. е. это локализуемая строка.

timeseries

TimeSeriesElement[]

Временные ряды, возвращаемые при выполнении запроса данных.

type

string

Тип ресурса метрики.

unit

MetricUnit

Единица измерения метрики.

MetricUnit

Единица измерения метрики.

Имя Тип Описание
BitsPerSecond

string

Единица скорости двоичных цифр в секунду.

ByteSeconds

string

Единица передачи или хранения данных. Это размер данных в байтах, умноженный на время, необходимое для передачи или хранения данных в секундах.

Bytes

string

Единица памяти в байтах.

BytesPerSecond

string

Скорость единицы памяти в байтах в секунду.

Cores

string

Единица вычислительной мощности.

Count

string

Единица необработанного количества.

CountPerSecond

string

Единица скорости количества необработанных ресурсов в секунду.

MilliCores

string

Единица вычислительной мощности в 1/1000 ядер ЦП.

MilliSeconds

string

Единица времени в 1/1000 секунды.

NanoCores

string

Единица вычислительной мощности в миллиардной части ядра ЦП.

Percent

string

Процентная единица.

Seconds

string

Единица времени в секундах.

Unspecified

string

Нет указанной единицы измерения.

MetricValue

Представляет значение метрики.

Имя Тип Описание
average

number

Среднее значение в диапазоне времени.

count

number

Количество выборок в диапазоне времени. Можно использовать для определения количества значений, которые способствовали среднему значению.

maximum

number

Наибольшее значение в диапазоне времени.

minimum

number

Наименьшее значение в диапазоне времени.

timeStamp

string

Метка времени для значения метрики в формате ISO 8601.

total

number

Сумма всех значений в диапазоне времени.

Response

Ответ на запрос метрик.

Имя Тип Описание
cost

number

Целочисленное значение, представляющее относительную стоимость запроса.

interval

string

Интервал (размер окна), для которого данные метрик были возвращены в формате длительности ISO 8601 с особым регистром для значения FULL, возвращающего одну точку данных для всего запрошенного периода времени (примеры: PT15M, PT1H, P1D, FULL). Это может быть изменено и отличаться от первоначально запрошенного, если задан параметр AutoAdjustTimegrain=true. Этот параметр отсутствует, если был сделан запрос на метаданные.

namespace

string

Пространство имен запрашиваемых метрик

resourceregion

string

Регион запрашиваемого ресурса для метрик.

timespan

string

Временной диапазон, для которого были получены данные. Его значение состоит из двух объединенных значений datetime, разделенных "/". Это может быть скорректировано в будущем и возвращено обратно из того, что было первоначально запрошено.

value

Metric[]

Значение коллекции.

ResultType

Уменьшает набор собираемых данных. Допустимый синтаксис зависит от операции. Дополнительные сведения см. в описании операции.

Имя Тип Описание
Data

string

Metadata

string

TimeSeriesElement

Тип результата временных рядов. В данном случае дискриминатором всегда является TimeSeries.

Имя Тип Описание
data

MetricValue[]

Массив точек данных, представляющих значения метрик. Возвращается только в том случае, если указан результирующий тип данных.

metadatavalues

MetadataValue[]

Значения метаданных, возвращаемые, если в вызове было указано $filter.