Job - Get Task Counts

Service:

Batch Service

API Version:

2023-11-01.18.0

Hämtar antalet aktiviteter för det angivna jobbet.
Uppgiftsantal anger antalet aktiviteter efter aktivt, pågående eller slutfört aktivitetstillstånd och antalet aktiviteter som lyckades eller misslyckades. Uppgifter i förberedelsetillståndet räknas som aktiva. Observera att de returnerade talen kanske inte alltid är uppdaterade. Om du behöver exakta uppgiftsantal använder du en listfråga.

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

Name	I	Obligatorisk	Typ	Description
batchUrl	path	True	string	Bas-URL:en för alla Azure Batch tjänstbegäranden.
jobId	path	True	string	Jobbets ID.
api-version	query	True	string	Klient-API-version.
timeout	query		integer int32	Den maximala tid som servern kan ägna åt att bearbeta begäran, i sekunder. Standardvärdet är 30 sekunder.

Begärandehuvud

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

Name	Obligatorisk	Typ	Description
client-request-id		string uuid	Den anropargenererade begärandeidentiteten i form av ett GUID utan dekoration, till exempel klammerparenteser, t.ex. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Om servern ska returnera client-request-id i svaret.
ocp-date		string date-time-rfc1123	Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till systemets aktuella klocktid. ange det uttryckligen om du anropar REST-API:et direkt.

Svar

Name	Typ	Description
200 OK	TaskCountsResult	Ett svar som innehåller antalet aktiviteter för det angivna jobbet. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	Felet från Batch-tjänsten.

Säkerhet

azure_auth

Microsoft Entra OAuth 2.0-autentiseringskodflöde

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

Scopes

Name	Description
user_impersonation	Personifiera ditt användarkonto

Authorization

Type: apiKey
In: header

Exempel

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

Definitioner

Name	Description
BatchError	Ett felsvar som tagits emot från Azure Batch-tjänsten.
BatchErrorDetail	Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar.
ErrorMessage	Ett felmeddelande som tas emot i ett Azure Batch felsvar.
TaskCounts	Uppgiften räknas för ett jobb.
TaskCountsResult	Uppgiften och TaskSlot räknas för ett jobb.
TaskSlotCounts	TaskSlot räknas för ett jobb.

BatchError

Ett felsvar som tagits emot från Azure Batch-tjänsten.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
message	ErrorMessage	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
values	BatchErrorDetail[]	En samling nyckel/värde-par som innehåller ytterligare information om felet.

BatchErrorDetail

Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar.

Name	Typ	Description
key	string	En identifierare som anger innebörden av egenskapen Value.
value	string	Den ytterligare information som ingår i felsvaret.

ErrorMessage

Ett felmeddelande som tas emot i ett Azure Batch felsvar.

Name	Typ	Description
lang	string	Språkkoden för felmeddelandet
value	string	Texten i meddelandet.

TaskCounts

Uppgiften räknas för ett jobb.

Name	Typ	Description
active	integer	Antalet aktiviteter i aktivt tillstånd.
completed	integer	Antalet uppgifter i slutfört tillstånd.
failed	integer	Antalet aktiviteter som misslyckades. En aktivitet misslyckas om dess resultat (som finns i egenskapen executionInfo) är "failure".
running	integer	Antalet aktiviteter i körnings- eller förberedelsetillståndet.
succeeded	integer	Antalet aktiviteter som lyckades. En aktivitet lyckas om resultatet (som finns i egenskapen executionInfo) är "success".

TaskCountsResult

Uppgiften och TaskSlot räknas för ett jobb.

Name	Typ	Description
taskCounts	TaskCounts	Antalet uppgifter per tillstånd.
taskSlotCounts	TaskSlotCounts	Antalet TaskSlots som krävs av Uppgifter per tillstånd.

TaskSlotCounts

TaskSlot räknas för ett jobb.

Name	Typ	Description
active	integer	Antalet TaskSlots för aktiva aktiviteter.
completed	integer	Antalet TaskSlots för slutförda aktiviteter.
failed	integer	Antalet TaskSlots för misslyckade aktiviteter.
running	integer	Antalet TaskSlots för att köra aktiviteter.
succeeded	integer	Antalet TaskSlots för slutförda aktiviteter.