Account - List Pool Node Counts

Ссылка

Служба:: Batch Service

Версия API:: 2024-07-01.20.0

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

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

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

GET {batchUrl}/nodecounts?$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.
maxresults	query		integer int32	Максимальное количество элементов, возвращаемых в ответе.
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	PoolNodeCountsListResult	Ответ содержит количество вычислительных узлов в каждом состоянии вычислительного узла, сгруппированного по пулу. Заголовки client-request-id: string request-id: string
Other Status Codes	BatchError	Ошибка из пакетной службы.

Имя

Тип

Описание

200 OK

PoolNodeCountsListResult

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

Заголовки

client-request-id: string
request-id: 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

Примеры

NodeCountsPayload

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

HTTP

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

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

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

BatchError

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

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

BatchErrorDetail

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

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

ErrorMessage

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

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

NodeCounts

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

Имя	Тип	Описание
creating	integer	Количество вычислительных узлов в состоянии создания.
deallocated	integer	Количество вычислительных узлов в освобожденном состоянии.
deallocating	integer	Количество вычислительных узлов в состоянии освобождения.
idle	integer	Количество вычислительных узлов в состоянии простоя.
leavingPool	integer	Количество вычислительных узлов в состоянии выхода изPool.
offline	integer	Количество вычислительных узлов в автономном состоянии.
preempted	integer	Количество вычислительных узлов в предварительном состоянии.
rebooting	integer	Количество вычислительных узлов в состоянии перезагрузки.
reimaging	integer	Количество вычислительных узлов в состоянии повторного развертывания.
running	integer	Количество вычислительных узлов в состоянии выполнения.
startTaskFailed	integer	Количество вычислительных узлов в состоянии startTaskFailed.
starting	integer	Количество вычислительных узлов в начальном состоянии.
total	integer	Общее количество вычислительных узлов.
unknown	integer	Количество вычислительных узлов в неизвестном состоянии.
unusable	integer	Количество вычислительных узлов в неиспользуемом состоянии.
upgradingOS	integer	Количество вычислительных узлов в состоянии обновленияOS.
waitingForStartTask	integer	Количество вычислительных узлов в состоянии waitForStartTask.

PoolNodeCounts

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

Имя	Тип	Описание
dedicated	NodeCounts	Количество выделенных вычислительных узлов в каждом состоянии.
lowPriority	NodeCounts	Количество точечных или низкоприоритетных вычислительных узлов в каждом состоянии.
poolId	string	Идентификатор пула.

PoolNodeCountsListResult

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

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

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

Account - List Pool Node Counts

Параметры URI

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

Ответы

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

azure_auth

Области

Authorization

Примеры

NodeCountsPayload

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

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

Определения

BatchError

BatchErrorDetail

ErrorMessage

NodeCounts

PoolNodeCounts

PoolNodeCountsListResult

Дополнительные ресурсы