Account - List Pool Node Counts

Service:

Batch Service

API Version:

2023-11-01.18.0

Hiermee haalt u het aantal rekenknooppunten in elke status op, gegroepeerd op pool. Houd er rekening mee dat de geretourneerde getallen mogelijk niet altijd up-to-date zijn. Als u het exacte aantal knooppunten nodig hebt, gebruikt u een lijstquery.

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-parameters

Name	In	Vereist	Type	Description
batchUrl	path	True	string	De basis-URL voor alle Azure Batch serviceaanvragen.
api-version	query	True	string	Client-API-versie.
$filter	query		string	Een OData $filter component. Zie voor meer informatie over het maken van dit filter https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch.
maxresults	query		integer int32	Het maximum aantal items dat in het antwoord moet worden geretourneerd.
timeout	query		integer int32	De maximale tijd die de server kan besteden aan het verwerken van de aanvraag, in seconden. De standaardwaarde is 30 seconden.

Aanvraagkoptekst

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

Name	Vereist	Type	Description
client-request-id		string uuid	De door de aanroeper gegenereerde aanvraagidentiteit, in de vorm van een GUID zonder decoratie, zoals accolades, bijvoorbeeld 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Of de server de client-request-id in het antwoord moet retourneren.
ocp-date		string date-time-rfc1123	Het tijdstip waarop de aanvraag is uitgegeven. Clientbibliotheken stellen dit doorgaans in op de huidige systeemkloktijd; stel deze expliciet in als u de REST API rechtstreeks aanroept.

Antwoorden

Name	Type	Description
200 OK	PoolNodeCountsListResult	Het antwoord bevat het aantal rekenknooppunten in elke status van het rekenknooppunt, gegroepeerd op pool. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	De fout van de Batch-service.

Beveiliging

azure_auth

Microsoft Entra OAuth 2.0-verificatiecodestroom

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

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Authorization

Type: apiKey
In: header

Voorbeelden

NodeCountsPayload

Sample Request

HTTP

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

Definities

Name	Description
BatchError	Een foutbericht ontvangen van de Azure Batch-service.
BatchErrorDetail	Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.
ErrorMessage	Een foutbericht ontvangen in een Azure Batch foutbericht.
NodeCounts	Het aantal rekenknooppunten in de status van elk rekenknooppunt.
PoolNodeCounts	Het aantal rekenknooppunten in elke status voor een pool.
PoolNodeCountsListResult	Het resultaat van het weergeven van het aantal rekenknooppunten in het account.

BatchError

Een foutbericht ontvangen van de Azure Batch-service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
message	ErrorMessage	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
values	BatchErrorDetail[]	Een verzameling sleutel-waardeparen met aanvullende informatie over de fout.

BatchErrorDetail

Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.

Name	Type	Description
key	string	Een id die de betekenis van de eigenschap Value aangeeft.
value	string	De aanvullende informatie die is opgenomen in de foutreactie.

ErrorMessage

Een foutbericht ontvangen in een Azure Batch foutbericht.

Name	Type	Description
lang	string	De taalcode van het foutbericht
value	string	De tekst van het bericht.

NodeCounts

Het aantal rekenknooppunten in de status van elk rekenknooppunt.

Name	Type	Description
creating	integer	Het aantal rekenknooppunten met de status Maken.
idle	integer	Het aantal rekenknooppunten met de niet-actieve status.
leavingPool	integer	Het aantal rekenknooppunten met de status leavingPool.
offline	integer	Het aantal rekenknooppunten met de offlinestatus.
preempted	integer	Het aantal rekenknooppunten met de status Preempted.
rebooting	integer	Het aantal rekenknooppunten met de status opnieuw opstarten.
reimaging	integer	Het aantal rekenknooppunten met de status voor opnieuw voltooien.
running	integer	Het aantal rekenknooppunten met de actieve status.
startTaskFailed	integer	Het aantal rekenknooppunten met de status startTaskFailed.
starting	integer	Het aantal rekenknooppunten met de beginstatus.
total	integer	Het totale aantal rekenknooppunten.
unknown	integer	Het aantal rekenknooppunten met de onbekende status.
unusable	integer	Het aantal rekenknooppunten met de status Onbruikbaar.
waitingForStartTask	integer	Het aantal rekenknooppunten met de status waitingForStartTask.

PoolNodeCounts

Het aantal rekenknooppunten in elke status voor een pool.

Name	Type	Description
dedicated	NodeCounts	Het aantal toegewezen rekenknooppunten in elke status.
lowPriority	NodeCounts	Het aantal spot-rekenknooppunten/rekenknooppunten met lage prioriteit in elke status.
poolId	string	De id van de pool.

PoolNodeCountsListResult

Het resultaat van het weergeven van het aantal rekenknooppunten in het account.

Name	Type	Description
odata.nextLink	string	De URL voor het ophalen van de volgende set resultaten.
value	PoolNodeCounts[]	Een lijst met het aantal rekenknooppunten per pool.