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

Metrics Batch - Batch

  • Ссылка
Служба:
Monitor
Версия API:
2023-10-01

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

POST {endpoint}/subscriptions/{subscriptionId}/metrics:getBatch?metricnamespace={metricnamespace}&metricnames={metricnames}&api-version=2023-10-01
С использованием необязательных параметров: 
POST {endpoint}/subscriptions/{subscriptionId}/metrics:getBatch?starttime={starttime}&endtime={endtime}&interval={interval}&metricnamespace={metricnamespace}&metricnames={metricnames}&aggregation={aggregation}&top={top}&orderby={orderby}&filter={filter}&rollupby={rollupby}&api-version=2023-10-01

Параметры URI

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

string

url

Используемая региональная конечная точка, например https://eastus.metrics.monitor.azure.com. Регион должен соответствовать региону запрошенных ресурсов. Для глобальных ресурсов регион должен быть "глобальным".
subscriptionId
 path True

string

uuid

Идентификатор подписки для ресурсов в этом пакете.
api-version
 query True

string

Версия API клиента.
metricnames
 query True

string[]

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

string

Пространство имен метрик, содержащее запрошенные имена метрик.
aggregation
 query

string

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

string

Время окончания запроса. Это строка в формате "гггг-ММ-ддТЧЧ:мм:ss.fffZ".
filter
 query

string

Фильтр используется для уменьшения набора возвращаемых данных метрик.
Пример
Метрика содержит метаданные 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 B eq 'b1' and C eq '*' or B = 'b2'
Это недопустимо, так как логический оператор или не может разделить два разных имени метаданных.
— возвращает все временные ряды, где A = a1, B = b1 и C = c1:
filter=A eq 'a1' and B eq 'b1' and Cq 'c1'
— возвращает все временные ряды, где A = a1
filter=A eq 'a1' and B eq '' and C eq ''.
interval
 query

string

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

string

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

string

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

string

Время начала запроса. Это строка в формате "гггг-ММ-ддТЧЧ:мм:ss.fffZ". Если вы указали параметр endtime, этот параметр является обязательным. Если указано только время начала, время окончания по умолчанию использует текущее время. Если интервал времени не указан, значение по умолчанию — 1 час.
top
 query

integer

int32

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

Текст запроса

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

string[]

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

Ответы

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

MetricResultsResponse

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

ErrorResponse

Описывает формат ответа об ошибке.

Заголовки

x-ms-error-code: string

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

AADToken

Проверка подлинности OAuth2 в Azure Active Directory

Тип: oauth2
Flow: application
URL-адрес токена: https://login.microsoftonline.com/common/oauth2/v2.0/token

Области

Имя Описание
https://metrics.monitor.azure.com/.default https://metrics.monitor.azure.com/.default

Примеры

Query Redis Metrics summary
Query Storage Metrics

Query Redis Metrics summary

Образец запроса

POST {endpoint}/subscriptions/12345678-abcd-1234-abcd-123456789abc/metrics:getBatch?starttime=2023-11-07T14:00:00.000Z&endtime=2023-11-07T18:00:00.000Z&interval=FULL&metricnamespace=Microsoft.Cache/Redis&metricnames=cacheWrite&aggregation=average&top=10&orderby=average desc&filter=ShardId eq '0'&rollupby=ShardId&api-version=2023-10-01

{
  "resourceids": [
    "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/test_redis/providers/Microsoft.Cache/Redis/redis5",
    "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/test_redis/providers/Microsoft.Cache/Redis/redis3",
    "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/test_redis/providers/Microsoft.Cache/Redis/redis2"
  ]
}

Пример ответа

Код состояния:
200 
{
  "values": [
    {
      "starttime": "2023-11-07T14:00:00Z",
      "endtime": "2023-11-07T18:00:00Z",
      "interval": "PT4H",
      "value": [
        {
          "id": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/test_redis/providers/Microsoft.Cache/Redis/redis5/providers/Microsoft.Insights/metrics/cacheWrite",
          "type": "Microsoft.Insights/metrics",
          "name": {
            "value": "cacheWrite",
            "localizedValue": "Cache Write"
          },
          "displayDescription": "The amount of data written to the cache in bytes per second. For more details, see https://aka.ms/redis/metrics.",
          "unit": "BytesPerSecond",
          "timeseries": [
            {
              "metadatavalues": [],
              "data": [
                {
                  "timeStamp": "2023-11-07T14:00:00Z",
                  "average": 35513.760416666664
                }
              ]
            }
          ],
          "errorCode": "Success"
        }
      ],
      "namespace": "microsoft.cache/redis",
      "resourceregion": "westus2",
      "resourceid": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/test_redis/providers/Microsoft.Cache/Redis/redis5"
    },
    {
      "starttime": "2023-11-07T14:00:00Z",
      "endtime": "2023-11-07T18:00:00Z",
      "interval": "PT4H",
      "value": [
        {
          "id": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/test_redis/providers/Microsoft.Cache/Redis/redis3/providers/Microsoft.Insights/metrics/cacheWrite",
          "type": "Microsoft.Insights/metrics",
          "name": {
            "value": "cacheWrite",
            "localizedValue": "Cache Write"
          },
          "displayDescription": "The amount of data written to the cache in bytes per second. For more details, see https://aka.ms/redis/metrics.",
          "unit": "BytesPerSecond",
          "timeseries": [
            {
              "metadatavalues": [],
              "data": [
                {
                  "timeStamp": "2023-11-07T14:00:00Z",
                  "average": 7135.0625
                }
              ]
            }
          ],
          "errorCode": "Success"
        }
      ],
      "namespace": "microsoft.cache/redis",
      "resourceregion": "westus2",
      "resourceid": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/test_redis/providers/Microsoft.Cache/Redis/redis3"
    },
    {
      "starttime": "2023-11-07T14:00:00Z",
      "endtime": "2023-11-07T18:00:00Z",
      "interval": "PT4H",
      "value": [
        {
          "id": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/test_redis/providers/Microsoft.Cache/Redis/redis2/providers/Microsoft.Insights/metrics/cacheWrite",
          "type": "Microsoft.Insights/metrics",
          "name": {
            "value": "cacheWrite",
            "localizedValue": "Cache Write"
          },
          "displayDescription": "The amount of data written to the cache in bytes per second. For more details, see https://aka.ms/redis/metrics.",
          "unit": "BytesPerSecond",
          "timeseries": [
            {
              "metadatavalues": [],
              "data": [
                {
                  "timeStamp": "2023-11-07T14:00:00Z",
                  "average": 6723.489583333333
                }
              ]
            }
          ],
          "errorCode": "Success"
        }
      ],
      "namespace": "microsoft.cache/redis",
      "resourceregion": "westus2",
      "resourceid": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/test_redis/providers/Microsoft.Cache/Redis/redis2"
    }
  ]
}
Код состояния:
default 
x-ms-error-code: BadRequest
{
  "error": {
    "additionalInfo": [
      {
        "type": "string",
        "info": "TraceId=dd033ebf1e260d815f4bccad149bbc15"
      },
      {
        "type": "string",
        "info": "ExceptionType=Microsoft.Online.Metrics.MetricsMP.Utilities.RPRequestFormatException"
      }
    ],
    "code": "BadRequest",
    "message": "Detected invalid time range parameters for API version 2023-10-01. Please use only starttime and endtime to specify a time range."
  }
}

Query Storage Metrics

Образец запроса

POST {endpoint}/subscriptions/12345678-abcd-1234-abcd-123456789abc/metrics:getBatch?starttime=2023-02-01T20:00:00.123Z&endtime=2023-02-01T23:00:00.345Z&interval=PT15M&metricnamespace=Microsoft.Storage/storageAccounts&metricnames=Ingress,Egress&aggregation=average,minimum,maximum&top=10&orderby=average desc&filter=ApiName eq 'GetBlob' or ApiName eq 'GetBlobServiceProperties' and Authentication eq '*'&api-version=2023-10-01

{
  "resourceids": [
    "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage1",
    "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage2"
  ]
}

Пример ответа

Код состояния:
200 
{
  "values": [
    {
      "starttime": "2023-02-01T20:00:00.123Z",
      "endtime": "2023-02-01T23:00:00.345Z",
      "interval": "PT15M",
      "value": [
        {
          "id": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage1/providers/Microsoft.Insights/metrics/Ingress",
          "type": "Microsoft.Insights/metrics",
          "name": {
            "value": "Ingress",
            "localizedValue": "Ingress"
          },
          "displayDescription": "The amount of ingress data, in bytes. This number includes ingress from an external client into Azure Storage as well as ingress within Azure.",
          "unit": "Bytes",
          "timeseries": [
            {
              "metadatavalues": [
                {
                  "name": {
                    "value": "apiname",
                    "localizedValue": "apiname"
                  },
                  "value": "GetBlob"
                },
                {
                  "name": {
                    "value": "authentication",
                    "localizedValue": "authentication"
                  },
                  "value": "SAS"
                }
              ],
              "data": [
                {
                  "timeStamp": "2023-02-01T20:00:00Z",
                  "average": 437,
                  "minimum": 437,
                  "maximum": 437
                },
                {
                  "timeStamp": "2023-02-01T20:15:00Z",
                  "average": 438.0735294117647,
                  "minimum": 437,
                  "maximum": 583
                },
                {
                  "timeStamp": "2023-02-01T20:30:00Z",
                  "average": 437,
                  "minimum": 437,
                  "maximum": 437
                },
                {
                  "timeStamp": "2023-02-01T20:45:00Z",
                  "average": 437.54477611940297,
                  "minimum": 437,
                  "maximum": 583
                },
                {
                  "timeStamp": "2023-02-01T21:00:00Z",
                  "average": 437,
                  "minimum": 437,
                  "maximum": 437
                },
                {
                  "timeStamp": "2023-02-01T21:15:00Z",
                  "average": 438.0735294117647,
                  "minimum": 437,
                  "maximum": 583
                },
                {
                  "timeStamp": "2023-02-01T21:30:00Z",
                  "average": 437,
                  "minimum": 437,
                  "maximum": 437
                },
                {
                  "timeStamp": "2023-02-01T21:45:00Z",
                  "average": 437.54477611940297,
                  "minimum": 437,
                  "maximum": 583
                },
                {
                  "timeStamp": "2023-02-01T22:00:00Z",
                  "average": 437,
                  "minimum": 437,
                  "maximum": 437
                },
                {
                  "timeStamp": "2023-02-01T22:15:00Z",
                  "average": 438.0735294117647,
                  "minimum": 437,
                  "maximum": 583
                },
                {
                  "timeStamp": "2023-02-01T22:30:00Z",
                  "average": 437,
                  "minimum": 437,
                  "maximum": 437
                },
                {
                  "timeStamp": "2023-02-01T22:45:00Z",
                  "average": 437.542750929368,
                  "minimum": 437,
                  "maximum": 583
                }
              ]
            },
            {
              "metadatavalues": [
                {
                  "name": {
                    "value": "apiname",
                    "localizedValue": "apiname"
                  },
                  "value": "GetBlobServiceProperties"
                },
                {
                  "name": {
                    "value": "authentication",
                    "localizedValue": "authentication"
                  },
                  "value": "AccountKey"
                }
              ],
              "data": [
                {
                  "timeStamp": "2023-02-01T20:00:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:45:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:00:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:45:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:00:00Z",
                  "average": 342,
                  "minimum": 342,
                  "maximum": 342
                },
                {
                  "timeStamp": "2023-02-01T22:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:45:00Z"
                }
              ]
            }
          ],
          "errorCode": "Success"
        },
        {
          "id": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage1/providers/Microsoft.Insights/metrics/Egress",
          "type": "Microsoft.Insights/metrics",
          "name": {
            "value": "Egress",
            "localizedValue": "Egress"
          },
          "displayDescription": "The amount of egress data. This number includes egress to external client from Azure Storage as well as egress within Azure. As a result, this number does not reflect billable egress.",
          "unit": "Bytes",
          "timeseries": [
            {
              "metadatavalues": [
                {
                  "name": {
                    "value": "apiname",
                    "localizedValue": "apiname"
                  },
                  "value": "GetBlobServiceProperties"
                },
                {
                  "name": {
                    "value": "authentication",
                    "localizedValue": "authentication"
                  },
                  "value": "AccountKey"
                }
              ],
              "data": [
                {
                  "timeStamp": "2023-02-01T20:00:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:45:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:00:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:45:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:00:00Z",
                  "average": 796,
                  "minimum": 796,
                  "maximum": 796
                },
                {
                  "timeStamp": "2023-02-01T22:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:45:00Z"
                }
              ]
            },
            {
              "metadatavalues": [
                {
                  "name": {
                    "value": "apiname",
                    "localizedValue": "apiname"
                  },
                  "value": "GetBlob"
                },
                {
                  "name": {
                    "value": "authentication",
                    "localizedValue": "authentication"
                  },
                  "value": "SAS"
                }
              ],
              "data": [
                {
                  "timeStamp": "2023-02-01T20:00:00Z",
                  "average": 361,
                  "minimum": 361,
                  "maximum": 361
                },
                {
                  "timeStamp": "2023-02-01T20:15:00Z",
                  "average": 365.83088235294116,
                  "minimum": 361,
                  "maximum": 1018
                },
                {
                  "timeStamp": "2023-02-01T20:30:00Z",
                  "average": 361,
                  "minimum": 361,
                  "maximum": 361
                },
                {
                  "timeStamp": "2023-02-01T20:45:00Z",
                  "average": 363.4514925373134,
                  "minimum": 361,
                  "maximum": 1018
                },
                {
                  "timeStamp": "2023-02-01T21:00:00Z",
                  "average": 361,
                  "minimum": 361,
                  "maximum": 361
                },
                {
                  "timeStamp": "2023-02-01T21:15:00Z",
                  "average": 365.83088235294116,
                  "minimum": 361,
                  "maximum": 1018
                },
                {
                  "timeStamp": "2023-02-01T21:30:00Z",
                  "average": 361,
                  "minimum": 361,
                  "maximum": 361
                },
                {
                  "timeStamp": "2023-02-01T21:45:00Z",
                  "average": 363.4514925373134,
                  "minimum": 361,
                  "maximum": 1018
                },
                {
                  "timeStamp": "2023-02-01T22:00:00Z",
                  "average": 361,
                  "minimum": 361,
                  "maximum": 361
                },
                {
                  "timeStamp": "2023-02-01T22:15:00Z",
                  "average": 365.83088235294116,
                  "minimum": 361,
                  "maximum": 1018
                },
                {
                  "timeStamp": "2023-02-01T22:30:00Z",
                  "average": 361,
                  "minimum": 361,
                  "maximum": 361
                },
                {
                  "timeStamp": "2023-02-01T22:45:00Z",
                  "average": 363.4423791821561,
                  "minimum": 361,
                  "maximum": 1018
                }
              ]
            }
          ],
          "errorCode": "Success"
        }
      ],
      "namespace": "microsoft.storage/storageaccounts",
      "resourceregion": "eastus",
      "resourceid": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage1"
    },
    {
      "starttime": "2023-02-01T20:00:00.123Z",
      "endtime": "2023-02-01T23:00:00.345Z",
      "interval": "PT15M",
      "value": [
        {
          "id": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage2/providers/Microsoft.Insights/metrics/Ingress",
          "type": "Microsoft.Insights/metrics",
          "name": {
            "value": "Ingress",
            "localizedValue": "Ingress"
          },
          "displayDescription": "The amount of ingress data, in bytes. This number includes ingress from an external client into Azure Storage as well as ingress within Azure.",
          "unit": "Bytes",
          "timeseries": [
            {
              "metadatavalues": [
                {
                  "name": {
                    "value": "apiname",
                    "localizedValue": "apiname"
                  },
                  "value": "GetBlobServiceProperties"
                },
                {
                  "name": {
                    "value": "authentication",
                    "localizedValue": "authentication"
                  },
                  "value": "AccountKey"
                }
              ],
              "data": [
                {
                  "timeStamp": "2023-02-01T20:00:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:45:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:00:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:45:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:00:00Z",
                  "average": 330,
                  "minimum": 330,
                  "maximum": 330
                },
                {
                  "timeStamp": "2023-02-01T22:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:45:00Z"
                }
              ]
            }
          ],
          "errorCode": "Success"
        },
        {
          "id": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage2/providers/Microsoft.Insights/metrics/Egress",
          "type": "Microsoft.Insights/metrics",
          "name": {
            "value": "Egress",
            "localizedValue": "Egress"
          },
          "displayDescription": "The amount of egress data. This number includes egress to external client from Azure Storage as well as egress within Azure. As a result, this number does not reflect billable egress.",
          "unit": "Bytes",
          "timeseries": [
            {
              "metadatavalues": [
                {
                  "name": {
                    "value": "apiname",
                    "localizedValue": "apiname"
                  },
                  "value": "GetBlobServiceProperties"
                },
                {
                  "name": {
                    "value": "authentication",
                    "localizedValue": "authentication"
                  },
                  "value": "AccountKey"
                }
              ],
              "data": [
                {
                  "timeStamp": "2023-02-01T20:00:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T20:45:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:00:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T21:45:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:00:00Z",
                  "average": 880,
                  "minimum": 880,
                  "maximum": 880
                },
                {
                  "timeStamp": "2023-02-01T22:15:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:30:00Z"
                },
                {
                  "timeStamp": "2023-02-01T22:45:00Z"
                }
              ]
            }
          ],
          "errorCode": "Success"
        }
      ],
      "namespace": "microsoft.storage/storageaccounts",
      "resourceregion": "eastus",
      "resourceid": "/subscriptions/12345678-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage2"
    }
  ]
}
Код состояния:
default 
x-ms-error-code: BadRequest
{
  "error": {
    "additionalInfo": [
      {
        "type": "string",
        "info": "TraceId={00000000-0000-0000-0000-000000000000}"
      },
      {
        "type": "string",
        "info": "ExceptionType=Microsoft.Online.Metrics.MetricsMP.Utilities.RPRequestFormatException"
      }
    ],
    "code": "BadRequest",
    "message": "Query endTime: 06/06/2021 00:00:00 is out of the Max metrics retention period: 93.00:00:00, traceId: {00000000-0000-0000-0000-000000000000}"
  }
}

Определения

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

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

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

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

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

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

Результирующих данных запроса.
MetricResultsResponse

Результат метрик для ресурса.
MetricUnit

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

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

Разделенный запятыми список идентификаторов ресурсов для запроса метрик.
TimeSeriesElement

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

Коллекция ответов на данные метрик для каждого ресурса, для каждой метрики.

ErrorAdditionalInfo

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

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

object

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

string

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

ErrorDetail

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

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

ErrorAdditionalInfo[]

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

string

Код ошибки.
details

ErrorDetail[]

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

string

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

string

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

ErrorResponse

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

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

ErrorDetail

Объект ошибки.

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

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

MetricResultsResponse

Результат метрик для ресурса.

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

Values[]

Коллекция ответов на данные метрик для каждого ресурса, для каждой метрики.

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

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

ResourceIdList

Разделенный запятыми список идентификаторов ресурсов для запроса метрик.

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

string[]

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

TimeSeriesElement

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

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

MetricValue[]

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

MetadataValue[]

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

Values

Коллекция ответов на данные метрик для каждого ресурса, для каждой метрики.

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

string

Время окончания в формате даты и времени, для которого были получены данные.
interval

string

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

string

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

string

Ресурс, к которому были запрошены метрики.
resourceregion

string

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

string

Время начала в формате даты и времени, для которого были получены данные.
value

Metric[]

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