Account - List Pool Node Counts

Service:

Batch Service

API-versie:

2024-07-01.20.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 exact aantal knooppunten nodig hebt, gebruikt u een lijstquery.

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

Met optionele parameters:

GET {batchUrl}/nodecounts?$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.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 https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batchvoor meer informatie over het maken van dit filter.
maxresults	query		integer int32	Het maximum aantal items dat moet worden geretourneerd in het antwoord.
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. Als de waarde groter is dan 30, wordt in plaats daarvan de standaardwaarde gebruikt.

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 clientaanvraag-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 kloktijd van het systeem; 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. Kopteksten 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
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Authorization

Type: apiKey
In: header

Voorbeelden

NodeCountsPayload

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
BatchError	Er is 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 dat is ontvangen in een Azure Batch-foutreactie.
NodeCounts	Het aantal rekenknooppunten in elke status van het 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

Er is 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 Waarde aangeeft.
value	string	De aanvullende informatie die is opgenomen in het foutbericht.

ErrorMessage

Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.

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

NodeCounts

Het aantal rekenknooppunten in elke status van het rekenknooppunt.

Name	Type	Description
creating	integer	Het aantal rekenknooppunten in de status maken.
deallocated	integer	Het aantal rekenknooppunten met de status Toewijzing ongedaan gemaakt.
deallocating	integer	Het aantal rekenknooppunten met de toewijzingsstatus.
idle	integer	Het aantal rekenknooppunten in de niet-actieve status.
leavingPool	integer	Het aantal rekenknooppunten met de status leavingPool.
offline	integer	Het aantal rekenknooppunten in de offlinestatus.
preempted	integer	Het aantal rekenknooppunten met de status Vooraf.
rebooting	integer	Het aantal rekenknooppunten met de herstartstatus.
reimaging	integer	Het aantal rekenknooppunten in de herinrichtingsstatus.
running	integer	Het aantal rekenknooppunten in de actieve status.
startTaskFailed	integer	Het aantal rekenknooppunten in de status startTaskFailed.
starting	integer	Het aantal rekenknooppunten in de beginstatus.
total	integer	Het totale aantal rekenknooppunten.
unknown	integer	Het aantal rekenknooppunten met de onbekende status.
unusable	integer	Het aantal rekenknooppunten met de onbruikbare status.
upgradingOS	integer	Het aantal rekenknooppunten met de upgradeSTATUS.
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 rekenknooppunten met spot-/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 rekenknooppunten per pool.