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

Pool - List Usage Metrics

  • Ссылка
Служба:
Batch Service
Версия API:
2023-11-01.18.0

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

GET {batchUrl}/poolusagemetrics?api-version=2023-11-01.18.0
С использованием необязательных параметров: 
GET {batchUrl}/poolusagemetrics?starttime={starttime}&endtime={endtime}&$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

Параметры URI

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

string

Базовый URL-адрес для всех пакетная служба Azure запросов на обслуживание.
api-version
 query True

string

Версия API клиента.
$filter
 query

string

Предложение $filter OData. Дополнительные сведения о создании этого фильтра см. в разделе https://docs.microsoft.com/en-us/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 секунд.

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

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

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

GET account.region.batch.azure.com/poolusagemetrics?api-version=2023-11-01.18.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://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).