Job - Get Task Counts

Service:

Batch Service

API Version:

2023-11-01.18.0

Lekéri a megadott feladat tevékenységszámát.
A tevékenységszámlálók az aktív, a futó vagy a befejezett tevékenységállapot, valamint a sikeres vagy sikertelen tevékenységek számát adják meg. Az előkészítési állapotban lévő tevékenységek futásnak számítanak. Vegye figyelembe, hogy a visszaadott számok nem mindig naprakészek. Ha pontos feladatszámra van szüksége, használjon lista lekérdezést.

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-paraméterek

Name	In	Kötelező	Típus	Description
batchUrl	path	True	string	Az összes Azure Batch szolgáltatáskérés alap URL-címe.
jobId	path	True	string	A feladat azonosítója.
api-version	query	True	string	Ügyfél API-verziója.
timeout	query		integer int32	A kérés feldolgozásának maximális időtartama másodpercben. Az alapértelmezett érték 30 mp.

Kérelem fejléce

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

Name	Kötelező	Típus	Description
client-request-id		string uuid	A hívó által generált kérési identitás guid formában, díszítés nélkül, például kapcsos zárójelek, például 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Azt jelzi, hogy a kiszolgálónak vissza kell-e adnia az ügyfél-kérelem azonosítóját a válaszban.
ocp-date		string date-time-rfc1123	A kérelem kiállításának időpontja. Az ügyfélkódtárak ezt általában az aktuális rendszeróra-időpontra állítják be; állítsa be explicit módon, ha a REST API-t közvetlenül hívja meg.

Válaszok

Name	Típus	Description
200 OK	TaskCountsResult	A megadott feladat tevékenységszámát tartalmazó válasz. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	A Batch szolgáltatás hibája.

Biztonság

azure_auth

Microsoft Entra OAuth 2.0 hitelesítési kódfolyamata

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

Scopes

Name	Description
user_impersonation	A felhasználói fiók megszemélyesítése

Authorization

Type: apiKey
In: header

Példák

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

Definíciók

Name	Description
BatchError	A Azure Batch szolgáltatástól kapott hibaválasz.
BatchErrorDetail	A Azure Batch hibaválaszban szereplő további információk egy eleme.
ErrorMessage	Hibaüzenet érkezett egy Azure Batch hibaválaszban.
TaskCounts	A tevékenység egy feladathoz számít.
TaskCountsResult	A Feladat és a FeladatSlot egy feladathoz számít.
TaskSlotCounts	A TaskSlot egy feladathoz számít.

BatchError

A Azure Batch szolgáltatástól kapott hibaválasz.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
message	ErrorMessage	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.
values	BatchErrorDetail[]	Kulcs-érték párok gyűjteménye, amely további részleteket tartalmaz a hibáról.

BatchErrorDetail

A Azure Batch hibaválaszban szereplő további információk egy eleme.

Name	Típus	Description
key	string	Az Érték tulajdonság jelentését meghatározó azonosító.
value	string	A hibaválaszban szereplő további információk.

ErrorMessage

Hibaüzenet érkezett egy Azure Batch hibaválaszban.

Name	Típus	Description
lang	string	A hibaüzenet nyelvkódja
value	string	Az üzenet szövege.

TaskCounts

A tevékenység egy feladathoz számít.

Name	Típus	Description
active	integer	Az aktív állapotban lévő tevékenységek száma.
completed	integer	A befejezett állapotban lévő tevékenységek száma.
failed	integer	A sikertelen tevékenységek száma. A feladat meghiúsul, ha az eredmény (a executionInfo tulajdonságban található) "hiba".
running	integer	A futó vagy előkészítési állapotban lévő tevékenységek száma.
succeeded	integer	A sikeres tevékenységek száma. A tevékenység akkor sikeres, ha az eredménye (a executionInfo tulajdonságban található) "sikeres".

TaskCountsResult

A Feladat és a FeladatSlot egy feladathoz számít.

Name	Típus	Description
taskCounts	TaskCounts	A Feladatok száma állapotonként.
taskSlotCounts	TaskSlotCounts	A Tevékenységek állapotonkénti tevékenységekhez szükséges tevékenységek száma.

TaskSlotCounts

A TaskSlot egy feladathoz számít.

Name	Típus	Description
active	integer	Az aktív tevékenységek tevékenységszlotjainak száma.
completed	integer	A befejezett tevékenységekhez tartozó TaskSlots száma.
failed	integer	A sikertelen tevékenységek tevékenységszlotjainak száma.
running	integer	A Feladatok futtatásához szükséges Tevékenységszlotok száma.
succeeded	integer	A sikeres tevékenységekhez tartozó TaskSlots száma.