Pools - List Pool Usage Metrics

Служба:: Batch Service

Версия API:: 2025-06-01

Перечисляет метрики использования, агрегированные пулом по отдельным интервалам времени для указанной учетной записи.
Если не указать предложение $filter, включая poolId, ответ включает все пулы, существующие в учетной записи, в диапазоне времени возвращаемых интервалов агрегирования. Если не указать предложение $filter, включая startTime или endTime, эти фильтры по умолчанию соответствуют времени начала и окончания последнего интервала агрегирования, доступного в данный момент; То есть возвращается только последний интервал агрегирования.

GET {endpoint}/poolusagemetrics?api-version=2025-06-01

С использованием необязательных параметров:

GET {endpoint}/poolusagemetrics?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}&startTime={startTime}&endtime={endtime}&$filter={$filter}

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	Конечная точка учетной записи пакетной службы (например, https://batchaccount.eastus2.batch.azure.com).
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.
$filter	query		string	Предложение OData $filter. Для получения дополнительной информации о построении этого фильтра см. https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.
endtime	query		string (date-time)	Последнее время для включения метрик. Это должно быть как минимум за два часа до текущего времени. Если не указано, по умолчанию это означает конечное время последнего доступного на данный момент интервала агрегации.
maxresults	query		integer (int32) minimum: 1 maximum: 1000	Максимальное количество элементов, возвращаемых в ответе. Максимум может быть возвращено 1000 заявок.
startTime	query		string (date-time)	Самое раннее время для включения метрик. Это должно быть как минимум за два с половиной часа до текущего времени. Если не указано, по умолчанию это относится к началу последнего доступного на данный момент интервала агрегации.
timeOut	query		integer (int32)	Максимальное время, которое сервер может тратить на обработку запроса в секундах. Значение по умолчанию — 30 секунд. Если значение превышает 30, вместо этого используется стандартное значение.".

Заголовок запроса

Имя	Тип	Описание
client-request-id	string	Удостоверение запроса, созданное вызывающим пользователем, в виде GUID без украшений, таких как фигурные скобки, например 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Должен ли сервер возвращать идентификатор client-request-id в ответе.
ocp-date	string (date-time-rfc7231)	Время выдачи запроса. Клиентские библиотеки обычно задают это в текущее время системных часов; задайте его явным образом, если вы вызываете REST API напрямую.

Ответы

Имя	Тип	Описание
200 OK	BatchPoolListUsageMetricsResult	Запрос выполнен успешно. Заголовки ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Непредвиденное сообщение об ошибке.

Имя

Тип

Описание

200 OK

BatchPoolListUsageMetricsResult

Запрос выполнен успешно.

Заголовки

ETag: string
Last-Modified: string
client-request-id: string
request-id: string

Other Status Codes

BatchError

Непредвиденное сообщение об ошибке.

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

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Области

Имя	Описание
https://batch.core.windows.net//.default

Примеры

Pool list usage metrics

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

HTTP

GET {endpoint}/poolusagemetrics?api-version=2025-06-01

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

Код состояния:: 200

{
  "value": [
    {
      "startTime": "2013-04-01T00:00:00Z",
      "endTime": "2013-04-01T00:30:00Z",
      "poolId": "p1",
      "vmSize": "a1",
      "totalCoreHours": 39.384838
    },
    {
      "startTime": "2013-04-01T00:30:00Z",
      "endTime": "2013-04-01T01:00:00Z",
      "poolId": "p2",
      "vmSize": "a8",
      "totalCoreHours": 3039.384838
    }
  ]
}

Определения

Имя	Описание
BatchError	Ответ об ошибке, полученный из пакетной службы Azure.
BatchErrorDetail	Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.
BatchErrorMessage	Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.
BatchPoolListUsageMetricsResult	Результат перечисления метрик использования для учетной записи.
BatchPoolUsageMetrics	Метрики использования для пула в интервале агрегирования.

BatchError

Объект

Ответ об ошибке, полученный из пакетной службы Azure.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
message	BatchErrorMessage	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
values	BatchErrorDetail[]	Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке.

BatchErrorDetail

Объект

Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.

Имя	Тип	Описание
key	string	Идентификатор, указывающий значение свойства Value.
value	string	Дополнительные сведения, включенные в ответ на ошибку.

BatchErrorMessage

Объект

Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.

Имя	Тип	Описание
lang	string	Языковой код сообщения об ошибке.
value	string	Текст сообщения.

BatchPoolListUsageMetricsResult

Объект

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

Имя	Тип	Описание
odata.nextLink	string (uri)	URL-адрес для получения следующего набора результатов.
value	BatchPoolUsageMetrics[]	Данные метрик использования пула.

BatchPoolUsageMetrics

Объект

Метрики использования для пула в интервале агрегирования.

Имя	Тип	Описание
endTime	string (date-time)	Конечное время интервала агрегации, покрываемого этой записью.
poolId	string	ID пула, метрики которого агрегированы в этой записи.
startTime	string (date-time)	Время начала интервала агрегации, охватываемого этой записью.
totalCoreHours	number (float)	Общее количество часов ядра, использованных в пуле за этот интервал агрегирования.
vmSize	string	Размер виртуальных машин в пуле. Все виртуальные машины в пуле одинакового размера. Сведения о доступных размерах виртуальных машин в пулах см. в статье Выбор размера виртуальной машины для вычислительных узлов в пуле пакетной службы Azure (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).