Job - Get Task Counts

Service:

Batch Service

API Version:

2023-11-01.18.0

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

GET {batchUrl}/jobs/{jobId}/taskcounts?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/jobs/{jobId}/taskcounts?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.
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.

Aanvraagkoptekst

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

Name	Vereist	Type	Description
client-request-id		string uuid	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 dit expliciet in als u de REST API rechtstreeks aanroept.

Antwoorden

Name	Type	Description
200 OK	TaskCountsResult	Een antwoord met het aantal taken voor de opgegeven taak. 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

Job get task counts

Sample Request

HTTP

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

Sample Response

Status code:

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	Een foutbericht dat is 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 antwoord.
TaskCounts	De taak telt voor een taak.
TaskCountsResult	De Taak en TaskSlot tellen voor een taak.
TaskSlotCounts	De TaskSlot telt voor een taak.

BatchError

Een foutbericht dat is 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 details 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 antwoord.

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

TaskCounts

De taak telt voor een taak.

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

TaskCountsResult

De Taak en TaskSlot tellen voor een taak.

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

TaskSlotCounts

De TaskSlot telt voor een taak.

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