Job - Get Task Counts

Service:

Batch Service

API Version:

2023-11-01.18.0

Získá počet úloh pro zadanou úlohu.
Počty úkolů poskytují počet úkolů podle stavu aktivních, spuštěných nebo dokončených úkolů a počet úspěšných nebo neúspěšných úkolů. Úkoly ve stavu přípravy se počítají jako spuštěné. Všimněte si, že vrácená čísla nemusí být vždy aktuální. Pokud potřebujete přesné počty úkolů, použijte dotaz na seznam.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
batchUrl	path	True	string	Základní adresa URL pro všechny požadavky služby Azure Batch.
jobId	path	True	string	ID úlohy.
api-version	query	True	string	Verze klientského rozhraní API.
timeout	query		integer int32	Maximální čas, který může server strávit zpracováním požadavku, v sekundách. Výchozí hodnota je 30 sekund.

Hlavička požadavku

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

Name	Vyžadováno	Typ	Description
client-request-id		string uuid	Identita požadavku vygenerovaná volajícím ve formě identifikátoru GUID bez ozdob, jako jsou složené závorky, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Jestli má server v odpovědi vrátit client-request-id.
ocp-date		string date-time-rfc1123	Čas, kdy byla žádost vystavena. Klientské knihovny obvykle tuto možnost nastaví na aktuální systémový čas. pokud přímo voláte rozhraní REST API, nastavte ho explicitně.

Odpovědi

Name	Typ	Description
200 OK	TaskCountsResult	Odpověď obsahující počet úkolů pro zadanou úlohu. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	Chyba ze služby Batch.

Zabezpečení

azure_auth

Microsoft Entra tok kódu ověřování OAuth 2.0

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

Scopes

Name	Description
user_impersonation	Zosobnění uživatelského účtu

Authorization

Type: apiKey
In: header

Příklady

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

Definice

Name	Description
BatchError	Ze služby Azure Batch byla přijata chybová odpověď.
BatchErrorDetail	Položka s dalšími informacemi, které jsou součástí Azure Batch odpovědi na chybu.
ErrorMessage	Chybová zpráva přijatá v Azure Batch odpověď na chybu.
TaskCounts	Úkol se počítá pro úlohu.
TaskCountsResult	Task a TaskSlot se počítají pro úlohu.
TaskSlotCounts	TaskSlot se počítá pro úlohu.

BatchError

Ze služby Azure Batch byla přijata chybová odpověď.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využívány programově.
message	ErrorMessage	Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.
values	BatchErrorDetail[]	Kolekce párů klíč-hodnota obsahující další podrobnosti o chybě.

BatchErrorDetail

Položka s dalšími informacemi, které jsou součástí Azure Batch odpovědi na chybu.

Name	Typ	Description
key	string	Identifikátor určující význam vlastnosti Value.
value	string	Další informace zahrnuté v chybové odpovědi.

ErrorMessage

Chybová zpráva přijatá v Azure Batch odpověď na chybu.

Name	Typ	Description
lang	string	Kód jazyka chybové zprávy
value	string	Text zprávy.

TaskCounts

Úkol se počítá pro úlohu.

Name	Typ	Description
active	integer	Počet úkolů v aktivním stavu.
completed	integer	Počet úkolů v dokončeném stavu.
failed	integer	Počet úkolů, které selhaly. Úloha selže, pokud její výsledek (nachází se ve vlastnosti executionInfo) je "selhání".
running	integer	Počet úkolů ve stavu spuštěných nebo přípravných.
succeeded	integer	Počet úspěšných úkolů. Úkol je úspěšný, pokud jeho výsledek (nachází se ve vlastnosti executionInfo) je "úspěch".

TaskCountsResult

Task a TaskSlot se počítají pro úlohu.

Name	Typ	Description
taskCounts	TaskCounts	Počet úkolů na stav.
taskSlotCounts	TaskSlotCounts	Počet úkolů požadovaných úkoly na stav.

TaskSlotCounts

TaskSlot se počítá pro úlohu.

Name	Typ	Description
active	integer	Počet objektů taskSlots pro aktivní úkoly.
completed	integer	Počet objektů taskSlots pro dokončené úkoly.
failed	integer	Počet objektů taskSlots pro neúspěšné úkoly.
running	integer	Počet objektů taskSlots pro spuštěné úlohy.
succeeded	integer	Počet objektů taskSlots pro úspěšné úkoly.