Pools - List Pool Node Counts

Служба:: Batch Service

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

Возвращает количество вычислительных узлов в каждом состоянии, сгруппированных по пулу. Обратите внимание, что возвращаемые числа могут не всегда быть актуальными. Если вам нужны точные счетчики узлов, используйте запрос списка.

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

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

GET {endpoint}/nodecounts?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}&$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-support-images.
maxresults	query		integer (int32) minimum: 1 maximum: 1000	Максимальное количество элементов, возвращаемых в ответе. Максимум может быть возвращено 1000 заявок.
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	BatchPoolNodeCountsListResult	Запрос выполнен успешно. Заголовки ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Непредвиденное сообщение об ошибке.

Имя

Тип

Описание

200 OK

BatchPoolNodeCountsListResult

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

Заголовки

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

Примеры

NodeCountsPayload

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

HTTP

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

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

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

{
  "value": [
    {
      "poolId": "pool1",
      "dedicated": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 0
      },
      "lowPriority": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 2,
        "starting": 1,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 3
      }
    },
    {
      "poolId": "pool2",
      "dedicated": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 1,
        "leavingPool": 0,
        "offline": 3,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 4
      },
      "lowPriority": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 0
      }
    },
    {
      "poolId": "pool3",
      "dedicated": {
        "creating": 0,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 5,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 4,
        "running": 0,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 9
      },
      "lowPriority": {
        "creating": 7,
        "deallocated": 0,
        "deallocating": 0,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 4,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 0,
        "upgradingOS": 0,
        "total": 11
      }
    }
  ]
}

Определения

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

BatchError

Объект

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

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

BatchErrorDetail

Объект

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

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

BatchErrorMessage

Объект

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

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

BatchNodeCounts

Объект

Количество вычислительных узлов в каждом состоянии вычислительного узла.

Имя	Тип	Описание
creating	integer (int32)	Количество вычислительных узлов в создающем состоянии.
deallocated	integer (int32)	Количество вычислительных узлов в распределённом состоянии.
deallocating	integer (int32)	Количество вычислительных узлов в состоянии деаллокинга.
idle	integer (int32)	Количество вычислительных узлов в состоянии простоя.
leavingPool	integer (int32)	Количество вычислительных узлов в состоянии leaveingPool.
offline	integer (int32)	Количество вычислительных узлов в офлайн-состоянии.
preempted	integer (int32)	Количество вычислительных узлов в превышенном состоянии.
rebooting	integer (int32)	Количество вычислительных узлов в состоянии перезагрузки.
reimaging	integer (int32)	Количество вычислительных узлов в состоянии переосмысления.
running	integer (int32)	Количество вычислительных узлов в рабочем состоянии.
startTaskFailed	integer (int32)	Количество вычислительных узлов в состоянии startTaskFail.
starting	integer (int32)	Количество вычислительных узлов в начальном состоянии.
total	integer (int32)	Общее количество вычислительных узлов.
unknown	integer (int32)	Количество вычислительных узлов в неизвестном состоянии.
unusable	integer (int32)	Количество вычислительных узлов в непригодном для использования состоянии.
upgradingOS	integer (int32)	Количество вычислительных узлов в состоянии upgradingOS.
waitingForStartTask	integer (int32)	Количество вычислительных узлов в состоянии ожиданияForStartTask.

BatchPoolNodeCounts

Объект

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

Имя	Тип	Описание
dedicated	BatchNodeCounts	Количество выделенных вычислительных узлов в каждом состоянии.
lowPriority	BatchNodeCounts	Количество точечных/низкоприоритетных вычислительных узлов в каждом состоянии.
poolId	string	The ID of the Pool.

BatchPoolNodeCountsListResult

Объект

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

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