Pool - List Usage Metrics

Служба:

Batch Service

Версия API:

2024-07-01.20.0

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

GET {batchUrl}/poolusagemetrics?api-version=2024-07-01.20.0

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

GET {batchUrl}/poolusagemetrics?starttime={starttime}&endtime={endtime}&$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

Параметры URI

Имя	В	Обязательно	Тип	Описание
batchUrl	path	True	string	Базовый URL-адрес для всех запросов пакетной службы Azure.
api-version	query	True	string	Версия КЛИЕНТСКОго 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	Максимальное количество элементов, возвращаемых в ответе. Возвращается не более 1000 результатов.
starttime	query		string date-time	Самое раннее время, из которого следует включить метрики. Это должно быть не менее двух с половиной часов до текущего времени. Если этот параметр не указан, по умолчанию используется время начала последнего интервала агрегирования, доступного в данный момент.
timeout	query		integer int32	Максимальное время, которое сервер может тратить на обработку запроса в секундах. Значение по умолчанию — 30 секунд. Если значение больше 30, вместо этого будет использоваться значение по умолчанию.

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

Media Types: "application/json; odata=minimalmetadata"

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

Ответы

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

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

azure_auth

Поток кода проверки подлинности Microsoft Entra OAuth 2.0

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

Области

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

Authorization

Тип: apiKey
В: header

Примеры

Pool list usage metrics

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

HTTP

GET account.region.batch.azure.com/poolusagemetrics?api-version=2024-07-01.20.0

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

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

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.
ErrorMessage	Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.
PoolListUsageMetricsResult	Результат перечисления метрик использования для учетной записи.
PoolUsageMetrics	Метрики использования для пула в интервале агрегирования.

BatchError

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

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

BatchErrorDetail

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

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

ErrorMessage

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

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

PoolListUsageMetricsResult

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

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

PoolUsageMetrics

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

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