Account - List Pool Node Counts

  • Ссылка
Service:
Batch Service
API Version:
2023-11-01.18.0

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

GET {batchUrl}/nodecounts?api-version=2023-11-01.18.0
With optional parameters: 
GET {batchUrl}/nodecounts?$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

Предложение OData $filter. Дополнительные сведения о создании этого фильтра см. в разделе https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch.
maxresults
 query

integer

int32

Максимальное количество элементов, возвращаемых в ответе.
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

PoolNodeCountsListResult

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

Headers

  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

Ошибка пакетной службы.

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

azure_auth

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

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Authorization

Type: apiKey
In: header

Примеры

NodeCountsPayload

Sample Request

GET account.region.batch.azure.com/nodecounts?api-version=2023-11-01.18.0

Sample Response

Status code:
200 
{
  "value": [
    {
      "poolId": "pool1",
      "dedicated": {
        "creating": 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,
        "total": 0
      },
      "lowPriority": {
        "creating": 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,
        "total": 3
      }
    },
    {
      "poolId": "pool2",
      "dedicated": {
        "creating": 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,
        "total": 4
      },
      "lowPriority": {
        "creating": 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,
        "total": 0
      }
    },
    {
      "poolId": "pool3",
      "dedicated": {
        "creating": 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,
        "total": 9
      },
      "lowPriority": {
        "creating": 7,
        "idle": 0,
        "leavingPool": 0,
        "offline": 0,
        "preempted": 0,
        "rebooting": 0,
        "reimaging": 0,
        "running": 4,
        "starting": 0,
        "startTaskFailed": 0,
        "unknown": 0,
        "unusable": 0,
        "waitingForStartTask": 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

Количество вычислительных узлов в состоянии создания.
idle

integer

Количество вычислительных узлов в состоянии простоя.
leavingPool

integer

Количество вычислительных узлов в состоянии leavingPool.
offline

integer

Количество вычислительных узлов в автономном состоянии.
preempted

integer

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

integer

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

integer

Количество вычислительных узлов в состоянии повторного воспроизведения образа.
running

integer

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

integer

Количество вычислительных узлов в состоянии startTaskFailed.
starting

integer

Число вычислительных узлов в начальном состоянии.
total

integer

Общее число вычислительных узлов.
unknown

integer

Число вычислительных узлов в неизвестном состоянии.
unusable

integer

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

integer

Количество вычислительных узлов в состоянии waitingForStartTask.

PoolNodeCounts

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

Имя Тип Описание
dedicated

NodeCounts

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

NodeCounts

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

string

Идентификатор пула.

PoolNodeCountsListResult

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

Имя Тип Описание
odata.nextLink

string

URL-адрес для получения следующего набора результатов.
value

PoolNodeCounts[]

Список количества вычислительных узлов по пулу.