Account - List Pool Node Counts

Service:

Batch Service

API Version:

2024-07-01.20.0

Gets the number of Compute Nodes in each state, grouped by Pool. Note that the numbers returned may not always be up to date. If you need exact node counts, use a list query.

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

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
batchUrl	path	True	string	The base URL for all Azure Batch service requests.
api-version	query	True	string	Client API Version.
$filter	query		string	An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch.
maxresults	query		integer int32	The maximum number of items to return in the response.
timeout	query		integer int32	The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.

Request Header

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

Name	Required	Type	Description
client-request-id		string uuid	The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Whether the server should return the client-request-id in the response.
ocp-date		string date-time-rfc1123	The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Responses

Name	Type	Description
200 OK	PoolNodeCountsListResult	The response contains the number of Compute Nodes in each Compute Node state, grouped by Pool. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	The error from the Batch service.

Security

azure_auth

Microsoft Entra OAuth 2.0 auth code flow

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

Scopes

Name	Description
user_impersonation	Impersonate your user account

Authorization

Type: apiKey
In: header

Examples

NodeCountsPayload

Sample request

HTTP

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

Sample response

Status code:

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
      }
    }
  ]
}

Definitions

Name	Description
BatchError	An error response received from the Azure Batch service.
BatchErrorDetail	An item of additional information included in an Azure Batch error response.
ErrorMessage	An error message received in an Azure Batch error response.
NodeCounts	The number of Compute Nodes in each Compute Node state.
PoolNodeCounts	The number of Compute Nodes in each state for a Pool.
PoolNodeCountsListResult	The result of listing the Compute Node counts in the Account.

BatchError

An error response received from the Azure Batch service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
message	ErrorMessage	A message describing the error, intended to be suitable for display in a user interface.
values	BatchErrorDetail[]	A collection of key-value pairs containing additional details about the error.

BatchErrorDetail

An item of additional information included in an Azure Batch error response.

Name	Type	Description
key	string	An identifier specifying the meaning of the Value property.
value	string	The additional information included with the error response.

ErrorMessage

An error message received in an Azure Batch error response.

Name	Type	Description
lang	string	The language code of the error message
value	string	The text of the message.

NodeCounts

The number of Compute Nodes in each Compute Node state.

Name	Type	Description
creating	integer	The number of Compute Nodes in the creating state.
deallocated	integer	The number of Compute Nodes in the deallocated state.
deallocating	integer	The number of Compute Nodes in the deallocating state.
idle	integer	The number of Compute Nodes in the idle state.
leavingPool	integer	The number of Compute Nodes in the leavingPool state.
offline	integer	The number of Compute Nodes in the offline state.
preempted	integer	The number of Compute Nodes in the preempted state.
rebooting	integer	The count of Compute Nodes in the rebooting state.
reimaging	integer	The number of Compute Nodes in the reimaging state.
running	integer	The number of Compute Nodes in the running state.
startTaskFailed	integer	The number of Compute Nodes in the startTaskFailed state.
starting	integer	The number of Compute Nodes in the starting state.
total	integer	The total number of Compute Nodes.
unknown	integer	The number of Compute Nodes in the unknown state.
unusable	integer	The number of Compute Nodes in the unusable state.
upgradingOS	integer	The number of Compute Nodes in the upgradingOS state.
waitingForStartTask	integer	The number of Compute Nodes in the waitingForStartTask state.

PoolNodeCounts

The number of Compute Nodes in each state for a Pool.

Name	Type	Description
dedicated	NodeCounts	The number of dedicated Compute Nodes in each state.
lowPriority	NodeCounts	The number of Spot/Low-priority Compute Nodes in each state.
poolId	string	The ID of the Pool.

PoolNodeCountsListResult

The result of listing the Compute Node counts in the Account.

Name	Type	Description
odata.nextLink	string	The URL to get the next set of results.
value	PoolNodeCounts[]	A list of Compute Node counts by Pool.