Job - Get Task Counts

Service:

Batch Service

API-versie:

2024-07-01.20.0

Hiermee haalt u het aantal taken voor de opgegeven taak op.
Taakaantallen bieden een telling van de taken per actieve, actieve of voltooide taakstatus en een aantal taken dat is geslaagd of mislukt. Taken in de voorbereidingsstatus worden meegeteld als actief. Houd er rekening mee dat de geretourneerde getallen mogelijk niet altijd up-to-date zijn. Als u exact aantal taken nodig hebt, gebruikt u een lijstquery.

GET {batchUrl}/jobs/{jobId}/taskcounts?api-version=2024-07-01.20.0

Met optionele parameters:

GET {batchUrl}/jobs/{jobId}/taskcounts?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.
jobId	path	True	string	De id van de taak.
api-version	query	True	string	Client-API-versie.
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	TaskCountsResult	Een antwoord met de taakaantallen voor de opgegeven taak. 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

Job get task counts

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

200

{
  "taskCounts": {
    "active": 5,
    "running": 7,
    "completed": 4,
    "succeeded": 2,
    "failed": 2
  },
  "taskSlotCounts": {
    "active": 5,
    "running": 7,
    "completed": 4,
    "succeeded": 2,
    "failed": 2
  }
}

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.
TaskCounts	De taak telt voor een taak.
TaskCountsResult	Het aantal taken en taakslots voor een taak.
TaskSlotCounts	De TaskSlot telt voor een taak.

BatchError

Object

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

Object

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

Object

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.

TaskCounts

Object

De taak telt voor een taak.

Name	Type	Description
active	integer (int32)	Het aantal taken in de actieve status.
completed	integer (int32)	Het aantal taken met de voltooide status.
failed	integer (int32)	Het aantal taken dat is mislukt. Een taak mislukt als het resultaat (gevonden in de eigenschap executionInfo) 'failure' is.
running	integer (int32)	Het aantal taken in de actieve status of de voorbereidingsstatus.
succeeded	integer (int32)	Het aantal taken dat is geslaagd. Een taak slaagt als het resultaat (gevonden in de eigenschap executionInfo) 'geslaagd' is.

TaskCountsResult

Object

Het aantal taken en taakslots voor een taak.

Name	Type	Description
taskCounts	TaskCounts	Het aantal taken per status.
taskSlotCounts	TaskSlotCounts	Het aantal TaskSlots dat per status is vereist voor taken.

TaskSlotCounts

Object

De TaskSlot telt voor een taak.

Name	Type	Description
active	integer (int32)	Het aantal TaskSlots voor actieve taken.
completed	integer (int32)	Het aantal TaskSlots voor voltooide taken.
failed	integer (int32)	Het aantal TaskSlots voor mislukte taken.
running	integer (int32)	Het aantal TaskSlots voor het uitvoeren van taken.
succeeded	integer (int32)	Het aantal TaskSlots voor geslaagde taken.