Job - List Preparation And Release Task Status

Referenz

Service:: Batch Service

API Version:: 2023-11-01.18.0

Listet die Ausführung status des Auftragsvorbereitungs- und Auftragsfreigabetasks für den angegebenen Auftrag auf den Computeknoten auf, auf denen der Auftrag ausgeführt wurde.
Diese API gibt den Auftragsvorbereitungs- und Auftragsfreigabetask status auf allen Computeknoten zurück, auf denen der Auftragsvorbereitungs- oder Auftragsfreigabetask ausgeführt wurde. Dies schließt Computeknoten ein, die inzwischen aus dem Pool entfernt wurden. Wenn diese API für einen Auftrag aufgerufen wird, der über keinen Auftragsvorbereitungs- oder Auftragsfreigabetask verfügt, gibt der Batch-Dienst HTTP-status Code 409 (Conflict) mit dem Fehlercode JobPreparationTaskNotSpecified zurück.

GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?$filter={$filter}&$select={$select}&maxresults={maxresults}&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.
$filter	query		string	Eine OData $filter-Klausel. Weitere Informationen zum Erstellen dieses Filters finden Sie unter https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status.
$select	query		string	Eine OData $select-Klausel.
maxresults	query		integer int32	Die maximale Anzahl von Elementen, die in der Antwort zurückgegeben werden sollen. Es können maximal 1.000 Tasks zurückgegeben werden.
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	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	CloudJobListPreparationAndReleaseTaskStatusResult	Eine Antwort, die eine Liste der Status von Auftragsvorbereitungs- und Auftragsfreigabeaufgaben enthält. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Der Fehler vom Batch-Dienst. Wenn diese API für einen Auftrag aufgerufen wird, der über keinen Auftragsvorbereitungs- oder Auftragsfreigabetask verfügt, gibt der Batch-Dienst HTTP-status Code 409 zurück.

Name

Typ

Beschreibung

200 OK

CloudJobListPreparationAndReleaseTaskStatusResult

Eine Antwort, die eine Liste der Status von Auftragsvorbereitungs- und Auftragsfreigabeaufgaben enthält.

Headers

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

Other Status Codes

BatchError

Der Fehler vom Batch-Dienst. Wenn diese API für einen Auftrag aufgerufen wird, der über keinen Auftragsvorbereitungs- oder Auftragsfreigabetask verfügt, gibt der Batch-Dienst HTTP-status Code 409 zurück.

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 list preparation and release task status

Sample Request

HTTP

GET account.region.batch.azure.com/jobs/jobId/jobpreparationandreleasetaskstatus?api-version=2023-11-01.18.0

Sample Response

Status code:: 200

{
  "value": [
    {
      "poolId": "poolId",
      "nodeId": "tvm-2167304207_1-20140905t174658z",
      "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z",
      "jobPreparationTaskExecutionInfo": {
        "state": "completed",
        "startTime": "2015-05-01T10:20:31Z",
        "endTime": "2015-05-02T20:12:42Z",
        "taskRootDirectory": "tasks/myjob/job-1/myjobpreptask",
        "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobpreptask",
        "exitCode": 0,
        "retryCount": 0
      },
      "jobReleaseTaskExecutionInfo": {
        "state": "completed",
        "startTime": "2015-05-01T10:20:31Z",
        "endTime": "2015-05-02T20:12:42Z",
        "taskRootDirectory": "tasks/myjob/job-1/myjobreleasetask",
        "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobreleasetask",
        "exitCode": 0
      }
    }
  ],
  "odata.nextLink": "https://account.region.batch.azure.com/jobs/myjob/jobpreparationandreleasestatus?$skipToken=tvm-2167304207_1-20140905t174658z&api-version=2023-11-01.18.0"
}

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.
CloudJobListPreparationAndReleaseTaskStatusResult	Das Ergebnis der Auflistung der status der Auftragsvorbereitungs- und Auftragsfreigabeaufgaben für einen Auftrag.
ErrorCategory	Die Kategorie des Fehlers.
ErrorMessage	Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wurde.
JobPreparationAndReleaseTaskExecutionInformation	Die status der Aufgaben zur Auftragsvorbereitung und Auftragsfreigabe auf einem Computeknoten.
JobPreparationTaskExecutionInformation	Enthält Informationen zur Ausführung eines Auftragsvorbereitungstasks auf einem Computeknoten.
JobPreparationTaskState	Der aktuelle Status des Auftragsvorbereitungstasks auf dem Computeknoten.
JobReleaseTaskExecutionInformation	Enthält Informationen zur Ausführung eines Auftragsfreigabetasks auf einem Computeknoten.
JobReleaseTaskState	Der aktuelle Status des Auftragsfreigabetasks auf dem Computeknoten.
NameValuePair	Stellt ein Name-Wert-Paar dar.
TaskContainerExecutionInformation	Enthält Informationen zum Container, den ein Task ausführt.
TaskExecutionResult	Das Ergebnis der Taskausführung.
TaskFailureInformation	Informationen zu einem Vorgangsfehler.

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, die für die Anzeige in einer Benutzeroberfläche geeignet sein soll.
values	BatchErrorDetail[]	Eine Auflistung von Schlüssel-Wert-Paaren mit zusätzlichen Details zum Fehler.

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.

CloudJobListPreparationAndReleaseTaskStatusResult

Das Ergebnis der Auflistung der status der Auftragsvorbereitungs- und Auftragsfreigabeaufgaben für einen Auftrag.

Name	Typ	Beschreibung
odata.nextLink	string	Die URL zum Abrufen des nächsten Resultsets.
value	JobPreparationAndReleaseTaskExecutionInformation[]	Eine Liste der Informationen zur Auftragsvorbereitung und Zur Ausführung des Auftragsfreigabetasks.

ErrorCategory

Die Kategorie des Fehlers.

Name	Typ	Beschreibung
servererror	string	Der Fehler ist auf ein internes Serverproblem zurückzuführen.
usererror	string	Der Fehler ist auf ein Benutzerproblem zurückzuführen, z. B. eine Fehlkonfiguration.

ErrorMessage

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

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

JobPreparationAndReleaseTaskExecutionInformation

Die status der Aufgaben zur Auftragsvorbereitung und Auftragsfreigabe auf einem Computeknoten.

Name	Typ	Beschreibung
jobPreparationTaskExecutionInfo	JobPreparationTaskExecutionInformation	Informationen zur Ausführung status des Auftragsvorbereitungstasks auf diesem Computeknoten.
jobReleaseTaskExecutionInfo	JobReleaseTaskExecutionInformation	Informationen zur Ausführung status des Auftragsfreigabetasks auf diesem Computeknoten. Diese Eigenschaft wird nur festgelegt, wenn der Auftragsfreigabetask auf dem Computeknoten ausgeführt wurde.
nodeId	string	Die ID des Computeknotens, auf den sich dieser Eintrag bezieht.
nodeUrl	string	Die URL des Computeknotens, auf den sich dieser Eintrag bezieht.
poolId	string	Die ID des Pools, der den Computeknoten enthält, auf den sich dieser Eintrag bezieht.

JobPreparationTaskExecutionInformation

Enthält Informationen zur Ausführung eines Auftragsvorbereitungstasks auf einem Computeknoten.

Name	Typ	Beschreibung
containerInfo	TaskContainerExecutionInformation	Informationen zum Container, unter dem der Task ausgeführt wird. Diese Eigenschaft wird nur festgelegt, wenn der Task in einem Containerkontext ausgeführt wird.
endTime	string	Der Zeitpunkt, zu dem der Auftragsvorbereitungstask abgeschlossen wurde. Diese Eigenschaft wird nur festgelegt, wenn sich die Aufgabe im Status Abgeschlossen befindet.
exitCode	integer	Der Exitcode des programms, das in der Task-Befehlszeile angegeben ist. Dieser Parameter wird nur zurückgegeben, wenn sich der Task im Status Abgeschlossen befindet. Der Exitcode für einen Prozess spiegelt die spezifische Konvention wider, die vom Anwendungsentwickler für diesen Prozess implementiert wurde. Wenn Sie den Exitcodewert verwenden, um Entscheidungen in Ihrem Code zu treffen, sollten Sie sicherstellen, dass Sie die vom Anwendungsprozess verwendete Exitcodekonvention kennen. Beachten Sie, dass der Exitcode auch vom Betriebssystem Compute Node generiert werden kann, z. B. wenn ein Prozess erzwungen beendet wird.
failureInfo	TaskFailureInformation	Informationen, die den Vorgangsfehler beschreiben, falls vorhanden. Diese Eigenschaft wird nur festgelegt, wenn sich der Task im Status Abgeschlossen befindet und ein Fehler aufgetreten ist.
lastRetryTime	string	Die letzte Zeit, zu der eine Wiederholung des Auftragsvorbereitungstask ausgeführt wurde. Diese Eigenschaft wird nur festgelegt, wenn der Task wiederholt wurde (d. h. retryCount ist ungleich null). Falls vorhanden, entspricht dies in der Regel startTime, kann sich jedoch unterscheiden, wenn der Task aus anderen Gründen als einem Wiederholungsversuch neu gestartet wurde. Wenn beispielsweise der Computeknoten während eines Wiederholungsversuchs neu gestartet wurde, wird startTime aktualisiert, lastRetryTime jedoch nicht.
result	TaskExecutionResult	Das Ergebnis der Taskausführung. Wenn der Wert "failed" lautet, finden Sie die Details des Fehlers in der failureInfo-Eigenschaft.
retryCount	integer	Gibt an, wie oft der Task vom Batch-Dienst wiederholt wurde. Fehler bei Der Aufgabenanwendung (Exitcode ungleich Null) werden wiederholt, Fehler bei der Vorverarbeitung (der Task konnte nicht ausgeführt werden) und Fehler beim Dateiupload werden nicht wiederholt. Der Batch-Dienst versucht den Task bis zu dem durch die Einschränkungen angegebenen Grenzwert. Fehler bei Der Aufgabenanwendung (Exitcode ungleich Null) werden wiederholt, Fehler bei der Vorverarbeitung (der Task konnte nicht ausgeführt werden) und Fehler beim Dateiupload werden nicht wiederholt. Der Batch-Dienst versucht den Task bis zu dem durch die Einschränkungen angegebenen Grenzwert.
startTime	string	Die Zeit, zu der die Ausführung des Tasks gestartet wurde. Wenn der Task neu gestartet oder wiederholt wurde, ist dies der letzte Zeitpunkt, zu dem die Ausführung des Tasks gestartet wurde.
state	JobPreparationTaskState	Der aktuelle Status des Auftragsvorbereitungstasks auf dem Computeknoten.
taskRootDirectory	string	Das Stammverzeichnis des Auftragsvorbereitungstask auf dem Computeknoten. Sie können diesen Pfad verwenden, um dateien abzurufen, die vom Task erstellt wurden, z. B. Protokolldateien.
taskRootDirectoryUrl	string	Die URL zum Stammverzeichnis des Auftragsvorbereitungstask auf dem Computeknoten.

JobPreparationTaskState

Der aktuelle Status des Auftragsvorbereitungstasks auf dem Computeknoten.

Name	Typ	Beschreibung
completed	string	Der Vorgang wurde mit dem Exitcode 0 beendet, oder der Vorgang hat sein Wiederholungslimit ausgeschöpft, oder der Batch-Dienst konnte den Task aufgrund von Fehlern bei der Vorgangsvorbereitung (z. B. Fehler beim Herunterladen von Ressourcendateien) nicht starten.
running	string	Der Task wird derzeit ausgeführt (einschließlich Wiederholungsversuchen).

JobReleaseTaskExecutionInformation

Enthält Informationen zur Ausführung eines Auftragsfreigabetasks auf einem Computeknoten.

Name	Typ	Beschreibung
containerInfo	TaskContainerExecutionInformation	Informationen zum Container, unter dem der Task ausgeführt wird. Diese Eigenschaft wird nur festgelegt, wenn der Task in einem Containerkontext ausgeführt wird.
endTime	string	Der Zeitpunkt, zu dem der Auftragsfreigabetask abgeschlossen wurde. Diese Eigenschaft wird nur festgelegt, wenn sich die Aufgabe im Status Abgeschlossen befindet.
exitCode	integer	Der Exitcode des programms, das in der Task-Befehlszeile angegeben ist. Dieser Parameter wird nur zurückgegeben, wenn sich der Task im Status Abgeschlossen befindet. Der Exitcode für einen Prozess spiegelt die spezifische Konvention wider, die vom Anwendungsentwickler für diesen Prozess implementiert wurde. Wenn Sie den Exitcodewert verwenden, um Entscheidungen in Ihrem Code zu treffen, sollten Sie sicherstellen, dass Sie die vom Anwendungsprozess verwendete Exitcodekonvention kennen. Beachten Sie, dass der Exitcode auch vom Betriebssystem Compute Node generiert werden kann, z. B. wenn ein Prozess erzwungen beendet wird.
failureInfo	TaskFailureInformation	Informationen, die den Vorgangsfehler beschreiben, falls vorhanden. Diese Eigenschaft wird nur festgelegt, wenn sich der Task im Status Abgeschlossen befindet und ein Fehler aufgetreten ist.
result	TaskExecutionResult	Das Ergebnis der Taskausführung. Wenn der Wert "failed" lautet, finden Sie die Details des Fehlers in der failureInfo-Eigenschaft.
startTime	string	Die Zeit, zu der die Ausführung des Tasks gestartet wurde. Wenn der Task neu gestartet oder wiederholt wurde, ist dies der letzte Zeitpunkt, zu dem die Ausführung des Tasks gestartet wurde.
state	JobReleaseTaskState	Der aktuelle Status des Auftragsfreigabetasks auf dem Computeknoten.
taskRootDirectory	string	Das Stammverzeichnis des Auftragsfreigabetasks auf dem Computeknoten. Sie können diesen Pfad verwenden, um dateien abzurufen, die vom Task erstellt wurden, z. B. Protokolldateien.
taskRootDirectoryUrl	string	Die URL zum Stammverzeichnis des Auftragsfreigabetasks auf dem Computeknoten.

JobReleaseTaskState

Der aktuelle Status des Auftragsfreigabetasks auf dem Computeknoten.

Name	Typ	Beschreibung
completed	string	Der Vorgang wurde mit dem Exitcode 0 beendet, oder der Vorgang hat sein Wiederholungslimit ausgeschöpft, oder der Batch-Dienst konnte den Task aufgrund von Fehlern bei der Vorgangsvorbereitung (z. B. Fehler beim Herunterladen von Ressourcendateien) nicht starten.
running	string	Der Task wird derzeit ausgeführt (einschließlich Wiederholungsversuchen).

NameValuePair

Stellt ein Name-Wert-Paar dar.

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

TaskContainerExecutionInformation

Enthält Informationen zum Container, den ein Task ausführt.

Name	Typ	Beschreibung
containerId	string	ID des Containers.
error	string	Ausführliche Fehlerinformationen zum Container. Dies ist die detaillierte Fehlerzeichenfolge des Docker-Diensts, sofern verfügbar. Es entspricht dem von "docker inspect" zurückgegebenen Fehlerfeld.
state	string	Der Status des Containers. Dies ist der Status des Containers gemäß dem Docker-Dienst. Es entspricht dem status Feld, das von "docker inspect" zurückgegeben wird.

TaskExecutionResult

Das Ergebnis der Taskausführung.

Name	Typ	Beschreibung
failure	string	Während der Verarbeitung des Vorgangs ist ein Fehler aufgetreten. Der Fehler ist möglicherweise aufgetreten, bevor der Vorgangsprozess gestartet wurde, während der Vorgangsprozess ausgeführt wurde oder nachdem der Vorgangsprozess beendet wurde.
success	string	Der Task wurde erfolgreich ausgeführt.

TaskFailureInformation

Informationen zu einem Vorgangsfehler.

Name	Typ	Beschreibung
category	ErrorCategory	Die Kategorie des Vorgangsfehlers.
code	string	Ein Bezeichner für den Taskfehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
details	NameValuePair[]	Eine Liste mit zusätzlichen Details im Zusammenhang mit dem Fehler.
message	string	Eine Meldung, die den Vorgangsfehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll.

Job - List Preparation And Release Task Status

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

azure_auth

Scopes

Authorization

Beispiele

Job list preparation and release task status

Sample Request

Sample Response

Definitionen

BatchError

BatchErrorDetail

CloudJobListPreparationAndReleaseTaskStatusResult

ErrorCategory

ErrorMessage

JobPreparationAndReleaseTaskExecutionInformation

JobPreparationTaskExecutionInformation

JobPreparationTaskState

JobReleaseTaskExecutionInformation

JobReleaseTaskState

NameValuePair

TaskContainerExecutionInformation

TaskExecutionResult

TaskFailureInformation

Zusätzliche Ressourcen