Job - List Preparation And Release Task Status

Referenz

Dienst:: Batch Service

API-Version:: 2024-07-01.20.0

Listet den Ausführungsstatus der Auftragsvorbereitungs- und Auftragsfreigabeaufgabe für den angegebenen Auftrag über die Computeknoten auf, auf denen der Auftrag ausgeführt wurde.
Diese API gibt den Auftragsvorbereitungs- und Auftragsveröffentlichungsvorgangsstatus für alle Computeknoten zurück, die die Aufgabe "Auftragsvorbereitung" oder "Auftragsfreigabe" ausgeführt haben. Dazu gehören Computeknoten, die seitdem aus dem Pool entfernt wurden. Wenn diese API für einen Auftrag aufgerufen wird, der keine Auftragsvorbereitungs- oder Auftragsfreigabeaufgabe enthält, gibt der Batchdienst DEN HTTP-Statuscode 409 (Conflict) mit einem Fehlercode von JobPreparationTaskNotSpecified zurück.

GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?api-version=2024-07-01.20.0

Mit optionalen Parametern:

GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.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://learn.microsoft.com/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. Maximal 1000 Vorgänge können zurückgegeben werden.
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. Wenn der Wert größer als 30 ist, wird stattdessen der Standardwert verwendet.

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. legen Sie sie explizit fest, wenn Sie die REST-API direkt aufrufen.

Antworten

Name	Typ	Beschreibung
200 OK	CloudJobListPreparationAndReleaseTaskStatusResult	Eine Antwort, die eine Liste der Aufgabenstatus "Auftragsvorbereitung" und "Auftragsfreigabe" enthält. Header client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Der Fehler vom Batchdienst. Wenn diese API für einen Auftrag aufgerufen wird, der keine Auftragsvorbereitungs- oder Auftragsfreigabeaufgabe aufweist, gibt der Batchdienst DEN HTTP-Statuscode 409 zurück.

Name

Typ

Beschreibung

200 OK

CloudJobListPreparationAndReleaseTaskStatusResult

Eine Antwort, die eine Liste der Aufgabenstatus "Auftragsvorbereitung" und "Auftragsfreigabe" enthält.

Header

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

Other Status Codes

BatchError

Der Fehler vom Batchdienst. Wenn diese API für einen Auftrag aufgerufen wird, der keine Auftragsvorbereitungs- oder Auftragsfreigabeaufgabe aufweist, gibt der Batchdienst DEN HTTP-Statuscode 409 zurück.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodefluss

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Authorization

Typ: apiKey
In: header

Beispiele

Job list preparation and release task status

Beispielanforderung

HTTP

GET account.region.batch.azure.com/jobs/jobId/jobpreparationandreleasetaskstatus?api-version=2024-07-01.20.0

Beispiel für eine Antwort

Statuscode:: 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=2024-07-01.20.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 des Status der Aufgabenvorbereitung und der Auftragsfreigabe für einen Auftrag.
ErrorCategory	Die Kategorie des Fehlers.
ErrorMessage	Eine Fehlermeldung, die in einer Azure Batch-Fehlerantwort empfangen wurde.
JobPreparationAndReleaseTaskExecutionInformation	Der Status der Aufgaben für die Auftragsvorbereitung und die Auftragsfreigabe auf einem Computeknoten.
JobPreparationTaskExecutionInformation	Enthält Informationen zur Ausführung einer Auftragsvorbereitungsaufgabe auf einem Computeknoten.
JobPreparationTaskState	Der aktuelle Status des Auftragsvorbereitungsvorgangs auf dem Computeknoten.
JobReleaseTaskExecutionInformation	Enthält Informationen zur Ausführung einer Auftragsfreigabeaufgabe auf einem Computeknoten.
JobReleaseTaskState	Der aktuelle Status der Auftragsfreigabeaufgabe auf dem Computeknoten.
NameValuePair	Stellt ein Name-Wert-Paar dar.
TaskContainerExecutionInformation	Enthält Informationen zum Container, den eine Aufgabe ausführt.
TaskExecutionResult	Das Ergebnis der Aufgabenausfü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 sollen programmgesteuert genutzt werden.
message	ErrorMessage	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

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 des Status der Aufgabenvorbereitung und der Auftragsfreigabe für einen Auftrag.

Name	Typ	Beschreibung
odata.nextLink	string	Die URL, um den nächsten Satz von Ergebnissen abzurufen.
value	JobPreparationAndReleaseTaskExecutionInformation[]	Eine Liste der Auftragsvorbereitungs- und Auftragsfreigabeinformationen zur Aufgabenausführung.

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 Nachricht.

JobPreparationAndReleaseTaskExecutionInformation

Der Status der Aufgaben für die Auftragsvorbereitung und die Auftragsfreigabe auf einem Computeknoten.

Name	Typ	Beschreibung
jobPreparationTaskExecutionInfo	JobPreparationTaskExecutionInformation	Informationen zum Ausführungsstatus des Auftragsvorbereitungsvorgangs auf diesem Computeknoten.
jobReleaseTaskExecutionInfo	JobReleaseTaskExecutionInformation	Informationen zum Ausführungsstatus der Auftragsfreigabeaufgabe auf diesem Computeknoten. Diese Eigenschaft wird nur festgelegt, wenn die Auftragsfreigabeaufgabe auf dem Computeknoten ausgeführt wurde.
nodeId	string	Die ID des Computeknotens, auf den dieser Eintrag verweist.
nodeUrl	string	Die URL des Computeknotens, auf den dieser Eintrag verweist.
poolId	string	Die ID des Pools, der den Computeknoten enthält, auf den dieser Eintrag verweist.

JobPreparationTaskExecutionInformation

Enthält Informationen zur Ausführung einer Auftragsvorbereitungsaufgabe auf einem Computeknoten.

Name	Typ	Beschreibung
containerInfo	TaskContainerExecutionInformation	Informationen zum Container, unter dem die Aufgabe ausgeführt wird. Diese Eigenschaft wird nur festgelegt, wenn die Aufgabe in einem Containerkontext ausgeführt wird.
endTime	string	Der Zeitpunkt, zu dem der Auftragsvorbereitungsvorgang abgeschlossen wurde. Diese Eigenschaft wird nur festgelegt, wenn sich der Vorgang im Status "Abgeschlossen" befindet.
exitCode	integer	Der Exitcode des Programms, das in der Befehlszeile "Aufgabe" angegeben ist. Dieser Parameter wird nur zurückgegeben, wenn sich der Vorgang im abgeschlossenen Zustand befindet. Der Exitcode für einen Prozess spiegelt die spezifische Konvention wider, die vom Anwendungsentwickler für diesen Prozess implementiert wird. Wenn Sie den Exit-Codewert verwenden, um Entscheidungen in Ihrem Code zu treffen, stellen Sie sicher, dass Sie die vom Anwendungsprozess verwendete Exit-Codekonvention kennen. Beachten Sie, dass der Beendigungscode möglicherweise auch vom Compute Node-Betriebssystem generiert wird, z. B. wenn ein Prozess forcibly beendet wird.
failureInfo	TaskFailureInformation	Informationen zur Beschreibung des Vorgangsfehlers, falls vorhanden. Diese Eigenschaft wird nur festgelegt, wenn sich der Vorgang im Abgeschlossenen Zustand befindet und ein Fehler aufgetreten ist.
lastRetryTime	string	Die letzte Zeit, zu der eine Wiederholung des Vorgangs "Auftragsvorbereitung" gestartet wurde. Diese Eigenschaft wird nur festgelegt, wenn der Vorgang erneut ausgeführt wurde (d. h. "retryCount" ist "nonzero"). Wenn vorhanden, ist dies in der Regel identisch mit startTime, kann jedoch anders sein, wenn die Aufgabe aus anderen Gründen als der Wiederholung neu gestartet wurde. Wenn beispielsweise der Computeknoten während eines Wiederholungsversuchs neu gestartet wurde, wird die startTime aktualisiert, aber die letzteRetryTime nicht.
result	TaskExecutionResult	Das Ergebnis der Aufgabenausführung. Wenn der Wert "failed" ist, werden die Details des Fehlers in der failureInfo-Eigenschaft gefunden.
retryCount	integer	Die Anzahl der Wiederholungen des Vorgangs durch den Batchdienst. Vorgangsanwendungsfehler (Nicht-Null-Beendigungscode) werden wiederholt, Vorverarbeitungsfehler (die Aufgabe konnte nicht ausgeführt werden) und Dateiuploadfehler werden nicht wiederholt. Der Batchdienst versucht den Vorgang bis zum durch die Einschränkungen angegebenen Grenzwert erneut. Vorgangsanwendungsfehler (Nicht-Null-Beendigungscode) werden wiederholt, Vorverarbeitungsfehler (die Aufgabe konnte nicht ausgeführt werden) und Dateiuploadfehler werden nicht wiederholt. Der Batchdienst versucht den Vorgang bis zum durch die Einschränkungen angegebenen Grenzwert erneut.
startTime	string	Der Zeitpunkt, zu dem die Aufgabe gestartet wurde. Wenn die Aufgabe neu gestartet oder erneut ausgeführt wurde, ist dies der letzte Zeitpunkt, zu dem die Aufgabe gestartet wurde.
state	JobPreparationTaskState	Der aktuelle Status des Auftragsvorbereitungsvorgangs auf dem Computeknoten.
taskRootDirectory	string	Das Stammverzeichnis der Auftragsvorbereitungsaufgabe auf dem Computeknoten. Sie können diesen Pfad verwenden, um dateien abzurufen, die von der Aufgabe erstellt wurden, z. B. Protokolldateien.
taskRootDirectoryUrl	string	Die URL zum Stammverzeichnis der Auftragsvorbereitungsaufgabe auf dem Computeknoten.

JobPreparationTaskState

Der aktuelle Status des Auftragsvorbereitungsvorgangs auf dem Computeknoten.

Name	Typ	Beschreibung
completed	string	Der Vorgang wurde mit dem Beendigungscode 0 beendet, oder der Vorgang hat seinen Wiederholungsgrenzwert erschöpft, oder der Batchdienst konnte den Vorgang aufgrund von Vorgangsvorbereitungsfehlern (z. B. Fehler beim Herunterladen von Ressourcendateien) nicht starten.
running	string	Die Aufgabe wird zurzeit ausgeführt (einschließlich Wiederholung).

JobReleaseTaskExecutionInformation

Enthält Informationen zur Ausführung einer Auftragsfreigabeaufgabe auf einem Computeknoten.

Name	Typ	Beschreibung
containerInfo	TaskContainerExecutionInformation	Informationen zum Container, unter dem die Aufgabe ausgeführt wird. Diese Eigenschaft wird nur festgelegt, wenn die Aufgabe in einem Containerkontext ausgeführt wird.
endTime	string	Der Zeitpunkt, zu dem die Aufgabe "Auftragsfreigabe" abgeschlossen wurde. Diese Eigenschaft wird nur festgelegt, wenn sich der Vorgang im Status "Abgeschlossen" befindet.
exitCode	integer	Der Exitcode des Programms, das in der Befehlszeile "Aufgabe" angegeben ist. Dieser Parameter wird nur zurückgegeben, wenn sich der Vorgang im abgeschlossenen Zustand befindet. Der Exitcode für einen Prozess spiegelt die spezifische Konvention wider, die vom Anwendungsentwickler für diesen Prozess implementiert wird. Wenn Sie den Exit-Codewert verwenden, um Entscheidungen in Ihrem Code zu treffen, stellen Sie sicher, dass Sie die vom Anwendungsprozess verwendete Exit-Codekonvention kennen. Beachten Sie, dass der Beendigungscode möglicherweise auch vom Compute Node-Betriebssystem generiert wird, z. B. wenn ein Prozess forcibly beendet wird.
failureInfo	TaskFailureInformation	Informationen zur Beschreibung des Vorgangsfehlers, falls vorhanden. Diese Eigenschaft wird nur festgelegt, wenn sich der Vorgang im Abgeschlossenen Zustand befindet und ein Fehler aufgetreten ist.
result	TaskExecutionResult	Das Ergebnis der Aufgabenausführung. Wenn der Wert "failed" ist, werden die Details des Fehlers in der failureInfo-Eigenschaft gefunden.
startTime	string	Der Zeitpunkt, zu dem die Aufgabe gestartet wurde. Wenn die Aufgabe neu gestartet oder erneut ausgeführt wurde, ist dies der letzte Zeitpunkt, zu dem die Aufgabe gestartet wurde.
state	JobReleaseTaskState	Der aktuelle Status der Auftragsfreigabeaufgabe auf dem Computeknoten.
taskRootDirectory	string	Das Stammverzeichnis der Auftragsfreigabeaufgabe auf dem Computeknoten. Sie können diesen Pfad verwenden, um dateien abzurufen, die von der Aufgabe erstellt wurden, z. B. Protokolldateien.
taskRootDirectoryUrl	string	Die URL zum Stammverzeichnis der Auftragsfreigabeaufgabe auf dem Computeknoten.

JobReleaseTaskState

Der aktuelle Status der Auftragsfreigabeaufgabe auf dem Computeknoten.

Name	Typ	Beschreibung
completed	string	Der Vorgang wurde mit dem Beendigungscode 0 beendet, oder der Vorgang hat seinen Wiederholungsgrenzwert erschöpft, oder der Batchdienst konnte den Vorgang aufgrund von Vorgangsvorbereitungsfehlern (z. B. Fehler beim Herunterladen von Ressourcendateien) nicht starten.
running	string	Die Aufgabe wird zurzeit ausgeführt (einschließlich Wiederholung).

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 eine Aufgabe ausführt.

Name	Typ	Beschreibung
containerId	string	Die ID des Containers.
error	string	Detaillierte Fehlerinformationen zum Container. Dies ist die detaillierte Fehlerzeichenfolge des Docker-Diensts, falls verfügbar. Es entspricht dem fehlerfeld, das von "docker inspect" zurückgegeben wird.
state	string	Der Status des Containers. Dies ist der Status des Containers gemäß dem Docker-Dienst. Es entspricht dem Statusfeld, das von "docker inspect" zurückgegeben wird.

TaskExecutionResult

Das Ergebnis der Aufgabenausführung.

Name	Typ	Beschreibung
failure	string	Fehler bei der Verarbeitung des Vorgangs. Möglicherweise ist der Fehler aufgetreten, bevor der Vorgangsprozess gestartet wurde, während der Aufgabenprozess ausgeführt wurde oder nachdem der Aufgabenvorgang beendet wurde.
success	string	Die Aufgabe 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 Vorgangsfehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details	NameValuePair[]	Eine Liste mit zusätzlichen Details im Zusammenhang mit dem Fehler.
message	string	Eine Meldung zur Beschreibung des Vorgangsfehlers, die für die Anzeige in einer Benutzeroberfläche geeignet ist.

Freigeben über

Job - List Preparation And Release Task Status

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

azure_auth

Bereiche

Authorization

Beispiele

Job list preparation and release task status

Beispielanforderung

Beispiel für eine Antwort

Definitionen

BatchError

BatchErrorDetail

CloudJobListPreparationAndReleaseTaskStatusResult

ErrorCategory

ErrorMessage

JobPreparationAndReleaseTaskExecutionInformation

JobPreparationTaskExecutionInformation

JobPreparationTaskState

JobReleaseTaskExecutionInformation

JobReleaseTaskState

NameValuePair

TaskContainerExecutionInformation

TaskExecutionResult

TaskFailureInformation

Zusätzliche Ressourcen