Tasks - List Sub Tasks

Dienst:: Batch Service

API-Version:: 2025-06-01

Listet alle Teilaufgaben auf, die mit der angegebenen Multi-Instanz-Aufgabe verknüpft sind.
Wenn die Aufgabe keine Multi-Instanz-Aufgabe ist, gibt dies eine leere Sammlung zurück.

GET {endpoint}/jobs/{jobId}/tasks/{taskId}/subtasksinfo?api-version=2025-06-01

Mit optionalen Parametern:

GET {endpoint}/jobs/{jobId}/tasks/{taskId}/subtasksinfo?api-version=2025-06-01&timeOut={timeOut}&$select={$select}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Batchkontoendpunkt (z. B. https://batchaccount.eastus2.batch.azure.com).
jobId	path	True	string	Die ID des Jobs.
taskId	path	True	string	Die ID der Aufgabe.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
$select	query		string[]	Eine OData-$select-Klausel.
timeOut	query		integer (int32)	Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden ausgeben kann. Der Standardwert ist 30 Sekunden. Ist der Wert größer als 30, wird stattdessen der Standard verwendet."

Anforderungsheader

Name	Typ	Beschreibung
client-request-id	string	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-rfc7231)	Der Zeitpunkt, zu dem die Anforderung ausgestellt wurde. Clientbibliotheken legen dies in der Regel auf die aktuelle Systemuhrzeit fest. legen Sie sie explizit fest, wenn Sie die REST-API direkt aufrufen.

Antworten

Name	Typ	Beschreibung
200 OK	BatchTaskListSubtasksResult	Die Anforderung ist erfolgreich. Header ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Unerwartete Fehlerantwort.

Name

Typ

Beschreibung

200 OK

BatchTaskListSubtasksResult

Die Anforderung ist erfolgreich.

Header

ETag: string
Last-Modified: string
client-request-id: string
request-id: string

Other Status Codes

BatchError

Unerwartete Fehlerantwort.

Sicherheit

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiche

Name	Beschreibung
https://batch.core.windows.net//.default

Beispiele

Task list subtasks

Beispielanforderung

HTTP

GET {endpoint}/jobs/jobId/tasks/taskId/subtasksinfo?api-version=2025-06-01

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "id": 1,
      "startTime": "2025-09-06T06:59:16.3139271Z",
      "endTime": "2025-09-06T06:59:20.0242024Z",
      "state": "completed",
      "stateTransitionTime": "2025-09-06T06:59:20.0242024Z",
      "previousState": "running",
      "previousStateTransitionTime": "2025-09-06T06:59:16.3139271Z",
      "exitCode": 0,
      "nodeInfo": {
        "affinityId": "TVM:tvm-2544493925_3-20160905t051718z",
        "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_3-20160905t051718z",
        "poolId": "mpiPool",
        "nodeId": "tvm-2544493925_3-20160905t051718z",
        "taskRootDirectory": "\\workitems\\jobId\\job-1\\taskId\\1",
        "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_3-20160905t051718z/files//workitems/jobId/job-1/taskId/1"
      }
    },
    {
      "id": 2,
      "startTime": "2025-09-06T06:59:16.9702844Z",
      "state": "running",
      "stateTransitionTime": "2025-09-06T06:59:16.9702844Z",
      "nodeInfo": {
        "affinityId": "TVM:tvm-2544493925_2-20160905t051718z",
        "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_2-20160905t051718z",
        "poolId": "mpiPool",
        "nodeId": "tvm-2544493925_2-20160905t051718z",
        "taskRootDirectory": "\\workitems\\jobId\\job-1\\taskId\\2",
        "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_2-20160905t051718z/files//workitems/jobId/job-1/taskId/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.
BatchErrorMessage	Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.
BatchErrorSourceCategory	BatchErrorSourceCategory-Enume
BatchNodeInfo	Informationen zum Computeknoten, auf dem eine Aufgabe ausgeführt wurde.
BatchSubtask	Informationen zu einem Azure Batch-Teilvorgang.
BatchSubtaskState	BatchSubtaskState-Enums
BatchTaskContainerExecutionInfo	Enthält Informationen zum Container, den eine Aufgabe ausführt.
BatchTaskExecutionResult	BatchTaskExecutionResult-Enume
BatchTaskFailureInfo	Informationen zu einem Vorgangsfehler.
BatchTaskListSubtasksResult	Das Ergebnis der Auflistung der Teilvorgänge eines Vorgangs.
NameValuePair	Stellt ein Name-Wert-Paar dar.

BatchError

Objekt

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.

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

BatchErrorDetail

Objekt

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.

BatchErrorMessage

Objekt

Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.

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

BatchErrorSourceCategory

Enumeration

BatchErrorSourceCategory-Enume

Wert	Beschreibung
usererror	Der Fehler liegt an einem Benutzerproblem, wie etwa einer Fehlkonfiguration.
servererror	Der Fehler liegt an einem internen Serverproblem.

BatchNodeInfo

Objekt

Informationen zum Computeknoten, auf dem eine Aufgabe ausgeführt wurde.

Name	Typ	Beschreibung
affinityId	string	Eine Identifikatorin für den Knoten, auf dem die Aufgabe lief, die beim Hinzufügen einer Aufgabe weitergegeben werden kann, um zu verlangen, dass die Aufgabe auf diesem Rechenknoten geplant wird.
nodeId	string	Die ID des Rechenknotens, auf dem die Aufgabe lief.
nodeUrl	string (uri)	Die URL des Compute-Knotens, auf dem die Aufgabe lief.
poolId	string	Die ID des Pools, auf dem die Aufgabe lief.
taskRootDirectory	string	Das Wurzelverzeichnis der Aufgabe auf dem Compute-Knoten.
taskRootDirectoryUrl	string (uri)	Die URL zum Root-Verzeichnis der Task auf dem Compute Node.

BatchSubtask

Objekt

Informationen zu einem Azure Batch-Teilvorgang.

Name	Typ	Beschreibung
containerInfo	BatchTaskContainerExecutionInfo	Informationen über den Container, unter dem die Aufgabe ausgeführt wird. Diese Eigenschaft wird nur gesetzt, wenn die Aufgabe in einem Containerkontext ausgeführt wird.
endTime	string (date-time)	Die Zeit, zu der die Teilaufgabe abgeschlossen wurde. Diese Eigenschaft wird nur gesetzt, wenn sich die Teilaufgabe im Zustand "Abgeschlossen" befindet.
exitCode	integer (int32)	Der Exit-Code des Programms ist in der Unteraufgaben-Befehlszeile angegeben. Diese Eigenschaft wird nur gesetzt, wenn sich die Unteraufgabe im abgeschlossenen Zustand befindet. Im Allgemeinen spiegelt der Ausgangscode eines Prozesses die spezifische Konvention wider, die vom Anwendungsentwickler für diesen Prozess implementiert wurde. Wenn Sie den Exit-Code-Wert verwenden, um Entscheidungen in Ihrem Code zu treffen, stellen Sie sicher, dass Sie die Exit-Code-Konvention kennen, die vom Anwendungsprozess verwendet wird. Wenn der Batch-Service jedoch die Unteraufgabe beendet (aufgrund von Timeout oder Benutzerbeendigung über die API), könnten Sie einen vom Betriebssystem definierten Exit-Code sehen.
failureInfo	BatchTaskFailureInfo	Informationen, die das Misserfolg der Aufgabe beschreiben, falls vorhanden. Diese Eigenschaft wird nur gesetzt, wenn sich die Aufgabe im abgeschlossenen Zustand befindet und auf einen Fehler stößt.
id	integer (int32)	Die ID der Unteraufgabe.
nodeInfo	BatchNodeInfo	Informationen über den Rechenknoten, auf dem die Unteraufgabe lief.
previousState	BatchSubtaskState	Der vorherige Zustand der Teilaufgabe. Diese Eigenschaft ist nicht gesetzt, wenn sich die Unteraufgabe im Anfangszustand befindet.
previousStateTransitionTime	string (date-time)	Der Zeitpunkt, zu dem die Unteraufgabe in ihren vorherigen Zustand eingetreten ist. Diese Eigenschaft ist nicht gesetzt, wenn sich die Unteraufgabe im Anfangszustand befindet.
result	BatchTaskExecutionResult	Das Ergebnis der Ausführung der Aufgabe. Wenn der Wert 'fehlgeschlagen' ist, können die Details des Scheiterns in der Eigenschaft failureInfo gefunden werden.
startTime	string (date-time)	Die Zeit, zu der die Teilaufgabe zu laufen begann. Wenn die Untertask neu gestartet oder erneut versucht wurde, ist dies der letzte Zeitpunkt, in dem die Untertask ausgeführt wurde.
state	BatchSubtaskState	Der aktuelle Zustand der Teilaufgabe.
stateTransitionTime	string (date-time)	Der Zeitpunkt, zu dem die Unteraufgabe in ihren aktuellen Zustand eingetreten ist.

BatchSubtaskState

Enumeration

BatchSubtaskState-Enums

Wert	Beschreibung
preparing	Die Aufgabe wurde einem Rechenknoten zugewiesen, wartet jedoch auf die Abschluss einer erforderlichen Jobvorbereitungsaufgabe auf dem Rechenknoten. Wenn die Aufgabe zur Jobvorbereitung erfolgreich ist, wird die Aufgabe zum Laufen übergegangen. Wenn die Aufgabe zur Jobvorbereitung fehlschlägt, wird sie wieder aktiv und kann einem anderen Rechenknoten zugewiesen werden.
running	Die Aufgabe läuft auf einem Compute-Knoten. Dazu gehört auch die Vorbereitung auf Aufgabenebene, wie das Herunterladen von Ressourcendateien oder das Bereitstellen von auf der Aufgabe angegebenen Paketen – das bedeutet nicht zwangsläufig, dass die Task-Befehlszeile bereits ausgeführt wurde.
completed	Die Aufgabe ist nicht mehr ausführbar, meist weil die Aufgabe erfolgreich abgeschlossen wurde oder die Aufgabe erfolglos abgeschlossen wurde und ihr Wiederholungslimit aufgebraucht ist. Eine Aufgabe wird ebenfalls als abgeschlossen markiert, wenn beim Starten der Aufgabe ein Fehler aufgetreten ist oder wenn die Aufgabe beendet wurde.

BatchTaskContainerExecutionInfo

Objekt

Enthält Informationen zum Container, den eine Aufgabe ausführt.

Name	Typ	Beschreibung
containerId	string	ID des Containers.
error	string	Detaillierte Fehlerinformationen zum Container. Dies ist die detaillierte Fehlerfolge des Docker-Dienstes, falls verfügbar. Es entspricht dem Fehlerfeld, das von "docker inspect" zurückgegeben wird.
state	string	Der Zustand des Behälters. Dies ist der Zustand des Containers laut dem Docker-Service. Es entspricht dem Statusfeld, das von "docker inspect" zurückgegeben wird.

BatchTaskExecutionResult

Enumeration

BatchTaskExecutionResult-Enume

Wert	Beschreibung
success	Die Aufgabe wurde erfolgreich durchgeführt.
failure	Es gab einen Fehler während der Bearbeitung der Aufgabe. Der Ausfall kann vor dem Start des Task-Prozesses, während der Task-Prozess ausgeführt wurde oder nachdem der Task-Prozess beendet war, aufgetreten sein.

BatchTaskFailureInfo

Objekt

Informationen zu einem Vorgangsfehler.

Name	Typ	Beschreibung
category	BatchErrorSourceCategory	Die Kategorie des Aufgabenfehlers.
code	string	Ein Kennzeichen für den Task-Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details	NameValuePair[]	Eine Liste zusätzlicher Details zu dem Fehler.
message	string	Eine Meldung, die den Aufgabenfehler beschreibt und für die Darstellung in einer Benutzeroberfläche geeignet sein soll.

BatchTaskListSubtasksResult

Objekt

Das Ergebnis der Auflistung der Teilvorgänge eines Vorgangs.

Name	Typ	Beschreibung
odata.nextLink	string (uri)	Die URL zum Abrufen der nächsten Ergebnisse.
value	BatchSubtask[]	Die Liste der Unteraufgaben.

NameValuePair

Objekt

Stellt ein Name-Wert-Paar dar.

Name	Typ	Beschreibung
name	string	Der Name im Namen-Wert-Paar.
value	string	Der Wert im Namen-Wert-Paar.

Freigeben über

Tasks - List Sub Tasks

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

OAuth2Auth

Bereiche

Beispiele

Task list subtasks

Beispielanforderung

Beispiel für eine Antwort

Definitionen

BatchError

BatchErrorDetail

BatchErrorMessage

BatchErrorSourceCategory

BatchNodeInfo

BatchSubtask

BatchSubtaskState

BatchTaskContainerExecutionInfo

BatchTaskExecutionResult

BatchTaskFailureInfo

BatchTaskListSubtasksResult

NameValuePair