Job - Get Task Counts

Service:

Batch Service

API Version:

2023-11-01.18.0

Ruft die Aufgabenanzahl für den angegebenen Auftrag ab.
Die Aufgabenanzahl gibt eine Anzahl der Aufgaben nach aktivem, ausgeführtem oder abgeschlossenem Vorgangsstatus und eine Anzahl von Vorgängen an, die erfolgreich oder fehlgeschlagen sind. Aufgaben im Vorbereitungszustand werden als ausgeführt gezählt. Beachten Sie, dass die zurückgegebenen Zahlen möglicherweise nicht immer auf dem neuesten Stand sind. Wenn Sie genaue Aufgabenanzahlen benötigen, verwenden Sie eine Listenabfrage.

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

Name	In	Erforderlich	Typ	Beschreibung
batchUrl	path	True	string	Die Basis-URL für alle Azure Batch-Dienstanforderungen.
jobId	path	True	string	Die ID des Auftrags.
api-version	query	True	string	Client-API-Version.
timeout	query		integer int32	Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden aufwenden kann. Der Standardwert ist 30 Sekunden.

Anforderungsheader

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

Name	Erforderlich	Typ	Beschreibung
client-request-id		string uuid	Die vom Aufrufer generierte Anforderungsidentität in Form einer GUID ohne Dekoration wie geschweifte Klammern, z. B. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Gibt an, ob der Server die Clientanforderungs-ID in der Antwort zurückgeben soll.
ocp-date		string date-time-rfc1123	Der Zeitpunkt, zu dem die Anforderung ausgestellt wurde. Clientbibliotheken legen dies in der Regel auf die aktuelle Systemuhrzeit fest. explizit festlegen, wenn Sie die REST-API direkt aufrufen.

Antworten

Name	Typ	Beschreibung
200 OK	TaskCountsResult	Eine Antwort, die die Aufgabenanzahl für den angegebenen Auftrag enthält. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	Der Fehler vom Batch-Dienst.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodeflow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Authorization

Type: apiKey
In: header

Beispiele

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

Definitionen

Name	Beschreibung
BatchError	Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.
BatchErrorDetail	Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind.
ErrorMessage	Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wird.
TaskCounts	Die Aufgabenanzahl für einen Auftrag.
TaskCountsResult	Die Anzahl "Task" und "TaskSlot" für einen Auftrag.
TaskSlotCounts	Der TaskSlot zählt für einen Auftrag.

BatchError

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
message	ErrorMessage	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll.
values	BatchErrorDetail[]	Eine Sammlung von Schlüssel-Wert-Paaren, die zusätzliche Details zum Fehler enthält.

BatchErrorDetail

Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind.

Name	Typ	Beschreibung
key	string	Ein Bezeichner, der die Bedeutung der Value-Eigenschaft angibt.
value	string	Die zusätzlichen Informationen, die in der Fehlerantwort enthalten sind.

ErrorMessage

Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wird.

Name	Typ	Beschreibung
lang	string	Der Sprachcode der Fehlermeldung
value	string	Der Text der Meldung.

TaskCounts

Die Aufgabenanzahl für einen Auftrag.

Name	Typ	Beschreibung
active	integer	Die Anzahl der Aufgaben im aktiven Zustand.
completed	integer	Die Anzahl der Aufgaben im Status abgeschlossen.
failed	integer	Die Anzahl der Vorgänge, bei denen ein Fehler aufgetreten ist. Ein Task schlägt fehl, wenn das Ergebnis (gefunden in der executionInfo-Eigenschaft) "fehler" ist.
running	integer	Die Anzahl der Aufgaben im Ausführungs- oder Vorbereitungsstatus.
succeeded	integer	Die Anzahl der erfolgreichen Aufgaben. Ein Task ist erfolgreich, wenn das Ergebnis (in der executionInfo-Eigenschaft gefunden) "success" lautet.

TaskCountsResult

Die Anzahl "Task" und "TaskSlot" für einen Auftrag.

Name	Typ	Beschreibung
taskCounts	TaskCounts	Die Anzahl der Aufgaben pro Status.
taskSlotCounts	TaskSlotCounts	Die Anzahl der TaskSlots, die von Tasks pro Status benötigt werden.

TaskSlotCounts

Der TaskSlot zählt für einen Auftrag.

Name	Typ	Beschreibung
active	integer	Die Anzahl von TaskSlots für aktive Aufgaben.
completed	integer	Die Anzahl von TaskSlots für abgeschlossene Aufgaben.
failed	integer	Die Anzahl von TaskSlots für fehlgeschlagene Tasks.
running	integer	Die Anzahl von TaskSlots zum Ausführen von Tasks.
succeeded	integer	Die Anzahl von TaskSlots für erfolgreiche Tasks.