Metrics - List At Subscription Scope
Списки данные метрик для подписки.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/metrics?api-version=2023-10-01®ion={region}
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/metrics?api-version=2023-10-01®ion={region}×pan={timespan}&interval={interval}&metricnames={metricnames}&aggregation={aggregation}&top={top}&orderby={orderby}&$filter={$filter}&resultType={resultType}&metricnamespace={metricnamespace}&AutoAdjustTimegrain={AutoAdjustTimegrain}&ValidateDimensions={ValidateDimensions}&rollupby={rollupby}
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
subscription
|
path | True |
string |
Идентификатор целевой подписки. |
api-version
|
query | True |
string |
Версия API, используемая для данной операции. |
region
|
query | True |
string |
Регион, в котором находятся нужные метрики. |
$filter
|
query |
string |
$filter используется для уменьшения набора возвращаемых данных метрик. |
|
aggregation
|
query |
string |
Список типов агрегирования (разделенных запятыми) для извлечения. Примеры: среднее, минимальное, максимальное |
|
Auto
|
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 |
|
result
|
query |
Сокращает набор собираемых данных. Допустимый синтаксис зависит от операции. Дополнительные сведения см. в описании операции. |
||
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. |
|
Validate
|
query |
boolean |
Если задано значение false, недопустимые значения параметров фильтра будут игнорироваться. Если задано значение true, возвращается ошибка для недопустимых параметров фильтра. По умолчанию используется значение «true». |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Успешный запрос на получение списка значений метрик. |
|
Other Status Codes |
Ответ об ошибке, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
Get subscription level metric data |
Get subscription level metric metadata |
Get subscription level metric data
Sample Request
GET https://management.azure.com/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/providers/Microsoft.Insights/metrics?api-version=2023-10-01®ion=westus2×pan=2021-06-08T19:00:00Z/2021-06-12T01:00:00Z&interval=PT6H&metricnames=Data Disk Max Burst IOPS&aggregation=count&top=10&orderby=count desc&$filter=LUN eq '0' and Microsoft.ResourceId eq '*'&metricnamespace=microsoft.compute/virtualmachines&AutoAdjustTimegrain=True&ValidateDimensions=False
Sample Response
{
"cost": 4679,
"timespan": "2021-06-08T19:00:00Z/2021-06-12T01:00:00Z",
"interval": "PT6H",
"value": [
{
"id": "subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/providers/Microsoft.Insights/metrics/Data Disk Max Burst IOPS",
"type": "Microsoft.Insights/metrics",
"name": {
"value": "Data Disk Max Burst IOPS",
"localizedValue": "Data Disk Max Burst IOPS"
},
"displayDescription": "Maximum IOPS Data Disk can achieve with bursting",
"unit": "Count",
"timeseries": [
{
"metadatavalues": [
{
"name": {
"value": "microsoft.resourceid",
"localizedValue": "microsoft.resourceid"
},
"value": "/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/resourceGroups/sas1/providers/Microsoft.Compute/virtualMachines/sas1-dev"
}
],
"data": [
{
"timeStamp": "2021-06-08T19:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-09T01:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-09T07:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-09T13:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-09T19:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-10T01:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-10T07:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-10T13:00:00Z",
"count": 413
},
{
"timeStamp": "2021-06-10T19:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-11T01:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-11T07:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-11T13:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-11T19:00:00Z",
"count": 72
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "microsoft.resourceid",
"localizedValue": "microsoft.resourceid"
},
"value": "/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/resourceGroups/sas2/providers/Microsoft.Compute/virtualMachines/sas2-vm"
}
],
"data": [
{
"timeStamp": "2021-06-08T19:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-09T01:00:00Z",
"count": 133
},
{
"timeStamp": "2021-06-09T07:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-09T13:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-09T19:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-10T01:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-10T07:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-10T13:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-10T19:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-11T01:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-11T07:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-11T13:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-11T19:00:00Z",
"count": 72
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "microsoft.resourceid",
"localizedValue": "microsoft.resourceid"
},
"value": "/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/resourceGroups/sas3/providers/Microsoft.Compute/virtualMachines/sas3-vm"
}
],
"data": [
{
"timeStamp": "2021-06-08T19:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-09T01:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-09T07:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-09T13:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-09T19:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-10T01:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-10T07:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-10T13:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-10T19:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-11T01:00:00Z",
"count": 78
},
{
"timeStamp": "2021-06-11T07:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-11T13:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-11T19:00:00Z",
"count": 72
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "microsoft.resourceid",
"localizedValue": "microsoft.resourceid"
},
"value": "/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/resourceGroups/sas4/providers/Microsoft.Compute/virtualMachines/sas4-vm"
}
],
"data": [
{
"timeStamp": "2021-06-08T19:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-09T01:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-09T07:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-09T13:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-09T19:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-10T01:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-10T07:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-10T13:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-10T19:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-11T01:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-11T07:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-11T13:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-11T19:00:00Z",
"count": 72
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "microsoft.resourceid",
"localizedValue": "microsoft.resourceid"
},
"value": "/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/resourceGroups/sas5/providers/Microsoft.Compute/virtualMachines/sas5-vm-asc"
}
],
"data": [
{
"timeStamp": "2021-06-08T19:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-09T01:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-09T07:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-09T13:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-09T19:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-10T01:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-10T07:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-10T13:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-10T19:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-11T01:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-11T07:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-11T13:00:00Z",
"count": 72
},
{
"timeStamp": "2021-06-11T19:00:00Z",
"count": 72
}
]
}
],
"errorCode": "Success"
}
],
"namespace": "microsoft.compute/virtualmachines",
"resourceregion": "westus2"
}
{
"error": {
"code": "BadRequest",
"message": "Missing required region params"
}
}
Get subscription level metric metadata
Sample Request
GET https://management.azure.com/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/providers/Microsoft.Insights/metrics?api-version=2023-10-01®ion=westus2×pan=2021-06-10T02:23:16.129Z/2021-06-12T02:23:16.129Z&metricnames=Data Disk Max Burst IOPS&$filter=LUN eq '0'&metricnamespace=microsoft.compute/virtualmachines
Sample Response
{
"timespan": "2021-06-10T02:23:16Z/2021-06-12T02:23:16Z",
"interval": "PT1M",
"value": [
{
"id": "subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/providers/Microsoft.Insights/metrics/Data Disk Read Bytes/sec",
"type": "Microsoft.Insights/metrics",
"name": {
"value": "Data Disk Read Bytes/sec",
"localizedValue": "Data Disk Read Bytes/Sec"
},
"displayDescription": "Bytes/Sec read from a single disk during monitoring period",
"unit": "BytesPerSecond",
"timeseries": [
{
"metadatavalues": [
{
"name": {
"value": "lun",
"localizedValue": "lun"
},
"value": "0"
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "lun",
"localizedValue": "lun"
},
"value": "1"
}
]
}
]
}
],
"namespace": "microsoft.compute/virtualmachines",
"resourceregion": "westus2"
}
Определения
Имя | Описание |
---|---|
Error |
Дополнительные сведения об ошибке управления ресурсами. |
Error |
Сообщение об ошибке |
Error |
Сообщение об ошибке |
Localizable |
Локализуемый строковый класс. |
Metadata |
Представляет значение метаданных метрики. |
Metric |
Результирующих данных запроса. |
Metric |
Сокращает набор собираемых данных. Допустимый синтаксис зависит от операции. Дополнительные сведения см. в описании операции. |
Metric |
Единица измерения метрики. |
Metric |
Представляет значение метрики. |
Response |
Ответ на запрос метрик. |
Time |
Тип результата временных рядов. В этом случае дискриминатором всегда является TimeSeries. |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
Имя | Тип | Описание |
---|---|---|
info |
object |
Дополнительные сведения. |
type |
string |
Тип дополнительных сведений. |
ErrorContract
Сообщение об ошибке
Имя | Тип | Описание |
---|---|---|
error |
Сообщение об ошибке |
ErrorResponse
Сообщение об ошибке
Имя | Тип | Описание |
---|---|---|
additionalInfo |
Дополнительные сведения об ошибке. |
|
code |
string |
Код ошибки. |
details |
Сведения об ошибке. |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект ошибки. |
LocalizableString
Локализуемый строковый класс.
Имя | Тип | Описание |
---|---|---|
localizedValue |
string |
Отображаемое имя. |
value |
string |
Инвариантное значение. |
MetadataValue
Представляет значение метаданных метрики.
Имя | Тип | Описание |
---|---|---|
name |
Имя метаданных. |
|
value |
string |
Значение метаданных. |
Metric
Результирующих данных запроса.
Имя | Тип | Описание |
---|---|---|
displayDescription |
string |
Подробное описание этой метрики. |
errorCode |
string |
"Успешно" или сведения об ошибке при сбоях запросов для этой метрики. |
errorMessage |
string |
Возникло сообщение об ошибке при запросе этой конкретной метрики. |
id |
string |
Идентификатор метрики. |
name |
Имя и отображаемое имя метрики, т. е. это локализуемая строка. |
|
timeseries |
Временный ряд, возвращаемый при выполнении запроса данных. |
|
type |
string |
Тип ресурса метрики. |
unit |
Единица измерения метрики. |
MetricResultType
Сокращает набор собираемых данных. Допустимый синтаксис зависит от операции. Дополнительные сведения см. в описании операции.
Имя | Тип | Описание |
---|---|---|
Data |
string |
|
Metadata |
string |
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[] |
Значение коллекции. |
TimeSeriesElement
Тип результата временных рядов. В этом случае дискриминатором всегда является TimeSeries.
Имя | Тип | Описание |
---|---|---|
data |
Массив точек данных, представляющих значения метрик. Возвращается только в том случае, если указан тип результирующих данных. |
|
metadatavalues |
Значения метаданных, возвращаемые, если в вызове был указан $filter. |