Job - List Preparation And Release Task Status

Usługa:

Batch Service

Wersja interfejsu API:

2024-07-01.20.0

Wyświetla stan wykonywania zadania przygotowania i zwolnienia zadania dla określonego zadania w węzłach obliczeniowych, w których zostało uruchomione zadanie.
Ten interfejs API zwraca stan zadania przygotowania zadania i zadania zwolnienia zadania na wszystkich węzłach obliczeniowych z uruchomionym zadaniem przygotowania zadania lub zwolnienia zadania. Obejmuje to węzły obliczeniowe, które zostały usunięte z puli. Jeśli ten interfejs API jest wywoływany w zadaniu, które nie ma zadania przygotowania zadania lub zwolnienia zadania, usługa Batch zwraca kod stanu HTTP 409 (konflikt) z kodem błędu JobPreparationTaskNotSpecified.

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

Z parametrami opcjonalnymi:

GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
batchUrl	path	True	string	Podstawowy adres URL dla wszystkich żądań usługi Azure Batch.
jobId	path	True	string	Identyfikator zadania.
api-version	query	True	string	Wersja interfejsu API klienta.
$filter	query		string	Klauzula OData $filter. Aby uzyskać więcej informacji na temat konstruowania tego filtru, zobacz https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status.
$select	query		string	Klauzula OData $select.
maxresults	query		integer int32	Maksymalna liczba elementów do zwrócenia w odpowiedzi. Można zwrócić maksymalnie 1000 zadań.
timeout	query		integer int32	Maksymalny czas przetwarzania żądania przez serwer w sekundach. Wartość domyślna to 30 sekund. Jeśli wartość jest większa niż 30, zostanie użyta wartość domyślna.

Nagłówek żądania

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

Nazwa	Wymagane	Typ	Opis
client-request-id		string uuid	Tożsamość żądania wygenerowanego przez obiekt wywołujący w postaci identyfikatora GUID bez dekoracji, takiej jak nawiasy klamrowe, np. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Czy serwer powinien zwrócić identyfikator żądania klienta w odpowiedzi.
ocp-date		string date-time-rfc1123	Czas wystawienia żądania. Biblioteki klienckie zazwyczaj ustawiają tę wartość na bieżący czas zegara systemowego; ustaw go jawnie, jeśli bezpośrednio wywołujesz interfejs API REST.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CloudJobListPreparationAndReleaseTaskStatusResult	Odpowiedź zawierająca listę stanów zadania przygotowania zadania i zadania zwolnienia zadania. Nagłówki client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Błąd usługi Batch. Jeśli ten interfejs API jest wywoływany w zadaniu, które nie ma zadania przygotowania lub zwolnienia zadania, usługa Batch zwraca kod stanu HTTP 409.

Zabezpieczenia

azure_auth

Microsoft Entra OAuth 2.0 — przepływ kodu uwierzytelniania

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	Personifikuj konto użytkownika

Authorization

Typ: apiKey
W: header

Przykłady

Job list preparation and release task status

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
BatchError	Odebrano odpowiedź o błędzie z usługi Azure Batch.
BatchErrorDetail	Element dodatkowych informacji zawartych w odpowiedzi na błąd usługi Azure Batch.
CloudJobListPreparationAndReleaseTaskStatusResult	Wynik wyświetlania stanu zadań przygotowania zadania i zadania zwolnienia zadania dla zadania.
ErrorCategory	Kategoria błędu.
ErrorMessage	Komunikat o błędzie odebrany w odpowiedzi na błąd usługi Azure Batch.
JobPreparationAndReleaseTaskExecutionInformation	Stan zadań przygotowania i wydania zadania podrzędnego w węźle obliczeniowym.
JobPreparationTaskExecutionInformation	Zawiera informacje o wykonywaniu zadania przygotowania zadania w węźle obliczeniowym.
JobPreparationTaskState	Bieżący stan zadania przygotowania zadania w węźle obliczeniowym.
JobReleaseTaskExecutionInformation	Zawiera informacje o wykonywaniu zadania zwolnienia zadania w węźle obliczeniowym.
JobReleaseTaskState	Bieżący stan zadania zwolnienia zadania w węźle obliczeniowym.
NameValuePair	Reprezentuje parę nazwa-wartość.
TaskContainerExecutionInformation	Zawiera informacje o kontenerze, który wykonuje zadanie.
TaskExecutionResult	Wynik wykonania zadania.
TaskFailureInformation	Informacje o niepowodzeniu zadania.

BatchError

Odebrano odpowiedź o błędzie z usługi Azure Batch.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
message	ErrorMessage	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
values	BatchErrorDetail[]	Kolekcja par klucz-wartość zawierająca dodatkowe szczegóły dotyczące błędu.

BatchErrorDetail

Element dodatkowych informacji zawartych w odpowiedzi na błąd usługi Azure Batch.

Nazwa	Typ	Opis
key	string	Identyfikator określający znaczenie właściwości Value.
value	string	Dodatkowe informacje zawarte w odpowiedzi na błąd.

CloudJobListPreparationAndReleaseTaskStatusResult

Wynik wyświetlania stanu zadań przygotowania zadania i zadania zwolnienia zadania dla zadania.

Nazwa	Typ	Opis
odata.nextLink	string	Adres URL umożliwiający uzyskanie następnego zestawu wyników.
value	JobPreparationAndReleaseTaskExecutionInformation[]	Lista informacji o przygotowaniu zadania i wykonaniu zadania zwolnienia zadania.

ErrorCategory

Kategoria błędu.

Nazwa	Typ	Opis
servererror	string	Błąd jest spowodowany wewnętrznym problemem z serwerem.
usererror	string	Błąd jest spowodowany problemem użytkownika, takim jak błędna konfiguracja.

ErrorMessage

Komunikat o błędzie odebrany w odpowiedzi na błąd usługi Azure Batch.

Nazwa	Typ	Opis
lang	string	Kod języka komunikatu o błędzie
value	string	Tekst wiadomości.

JobPreparationAndReleaseTaskExecutionInformation

Stan zadań przygotowania i wydania zadania podrzędnego w węźle obliczeniowym.

Nazwa	Typ	Opis
jobPreparationTaskExecutionInfo	JobPreparationTaskExecutionInformation	Informacje o stanie wykonywania zadania przygotowania zadania w tym węźle obliczeniowym.
jobReleaseTaskExecutionInfo	JobReleaseTaskExecutionInformation	Informacje o stanie wykonywania zadania zwolnienia zadania w tym węźle obliczeniowym. Ta właściwość jest ustawiana tylko wtedy, gdy zadanie zwolnienia zadania zostało uruchomione w węźle obliczeniowym.
nodeId	string	Identyfikator węzła obliczeniowego, do którego odwołuje się ten wpis.
nodeUrl	string	Adres URL węzła obliczeniowego, do którego odwołuje się ten wpis.
poolId	string	Identyfikator puli zawierającej węzeł obliczeniowy, do którego odwołuje się ten wpis.

JobPreparationTaskExecutionInformation

Zawiera informacje o wykonywaniu zadania przygotowania zadania w węźle obliczeniowym.

Nazwa	Typ	Opis
containerInfo	TaskContainerExecutionInformation	Informacje o kontenerze, w którym jest wykonywane zadanie. Ta właściwość jest ustawiana tylko wtedy, gdy zadanie jest uruchamiane w kontekście kontenera.
endTime	string	Czas, w którym zadanie przygotowania zadania zostało ukończone. Ta właściwość jest ustawiana tylko wtedy, gdy zadanie jest w stanie Ukończono.
exitCode	integer	Kod zakończenia programu określony w wierszu polecenia zadania. Ten parametr jest zwracany tylko wtedy, gdy zadanie jest w stanie ukończonym. Kod zakończenia procesu odzwierciedla konkretną konwencję zaimplementowaną przez dewelopera aplikacji dla tego procesu. Jeśli używasz wartości kodu zakończenia do podejmowania decyzji w kodzie, upewnij się, że znasz konwencję kodu zakończenia używaną przez proces aplikacji. Należy pamiętać, że kod zakończenia może być również generowany przez system operacyjny węzła obliczeniowego, na przykład w przypadku wymuszonego zakończenia procesu.
failureInfo	TaskFailureInformation	Informacje opisujące błąd zadania, jeśli istnieje. Ta właściwość jest ustawiana tylko wtedy, gdy zadanie jest w stanie ukończonym i napotkało błąd.
lastRetryTime	string	Ostatni raz, w którym uruchomiono ponawianie zadania przygotowania zadania. Ta właściwość jest ustawiana tylko wtedy, gdy zadanie zostało ponowione (tj. retryCount jest niezerowe). Jeśli jest obecny, zazwyczaj jest to samo co startTime, ale może się różnić, jeśli zadanie zostało uruchomione ponownie z powodów innych niż ponawianie próby; na przykład jeśli węzeł obliczeniowy został uruchomiony ponownie podczas ponawiania próby, godzina rozpoczęcia zostanie zaktualizowana, ale parametr lastRetryTime nie jest.
result	TaskExecutionResult	Wynik wykonania zadania. Jeśli wartość to "failed", szczegóły błędu można znaleźć we właściwości failureInfo.
retryCount	integer	Liczba ponownych prób wykonania zadania przez usługę Batch. Błędy aplikacji zadań (kod zakończenia niezerowy) są ponawiane, błędy przetwarzania wstępnego (nie można uruchomić zadania) i błędy przekazywania plików nie są ponawiane. Usługa Batch ponowi próbę wykonania zadania do limitu określonego przez ograniczenia. Błędy aplikacji zadań (kod zakończenia niezerowy) są ponawiane, błędy przetwarzania wstępnego (nie można uruchomić zadania) i błędy przekazywania plików nie są ponawiane. Usługa Batch ponowi próbę wykonania zadania do limitu określonego przez ograniczenia.
startTime	string	Czas, w którym zadanie zaczęło działać. Jeśli zadanie zostało ponownie uruchomione lub ponowione, jest to ostatni czas, w którym zadanie zostało uruchomione.
state	JobPreparationTaskState	Bieżący stan zadania przygotowania zadania w węźle obliczeniowym.
taskRootDirectory	string	Katalog główny zadania przygotowania zadania w węźle obliczeniowym. Za pomocą tej ścieżki można pobrać pliki utworzone przez zadanie, takie jak pliki dziennika.
taskRootDirectoryUrl	string	Adres URL do katalogu głównego zadania przygotowania zadania w węźle obliczeniowym.

JobPreparationTaskState

Bieżący stan zadania przygotowania zadania w węźle obliczeniowym.

Nazwa	Typ	Opis
completed	string	Zadanie zakończyło działanie z kodem zakończenia 0 lub zadanie wyczerpało limit ponawiania prób lub usługa Batch nie mogła uruchomić zadania z powodu błędów przygotowania zadania (takich jak błędy pobierania pliku zasobu).
running	string	Zadanie jest obecnie uruchomione (w tym ponawianie próby).

JobReleaseTaskExecutionInformation

Zawiera informacje o wykonywaniu zadania zwolnienia zadania w węźle obliczeniowym.

Nazwa	Typ	Opis
containerInfo	TaskContainerExecutionInformation	Informacje o kontenerze, w którym jest wykonywane zadanie. Ta właściwość jest ustawiana tylko wtedy, gdy zadanie jest uruchamiane w kontekście kontenera.
endTime	string	Czas, w którym zadanie zwolnienia zadania zostało ukończone. Ta właściwość jest ustawiana tylko wtedy, gdy zadanie jest w stanie Ukończono.
exitCode	integer	Kod zakończenia programu określony w wierszu polecenia zadania. Ten parametr jest zwracany tylko wtedy, gdy zadanie jest w stanie ukończonym. Kod zakończenia procesu odzwierciedla konkretną konwencję zaimplementowaną przez dewelopera aplikacji dla tego procesu. Jeśli używasz wartości kodu zakończenia do podejmowania decyzji w kodzie, upewnij się, że znasz konwencję kodu zakończenia używaną przez proces aplikacji. Należy pamiętać, że kod zakończenia może być również generowany przez system operacyjny węzła obliczeniowego, na przykład w przypadku wymuszonego zakończenia procesu.
failureInfo	TaskFailureInformation	Informacje opisujące błąd zadania, jeśli istnieje. Ta właściwość jest ustawiana tylko wtedy, gdy zadanie jest w stanie ukończonym i napotkało błąd.
result	TaskExecutionResult	Wynik wykonania zadania. Jeśli wartość to "failed", szczegóły błędu można znaleźć we właściwości failureInfo.
startTime	string	Czas, w którym zadanie zaczęło działać. Jeśli zadanie zostało ponownie uruchomione lub ponowione, jest to ostatni czas, w którym zadanie zostało uruchomione.
state	JobReleaseTaskState	Bieżący stan zadania zwolnienia zadania w węźle obliczeniowym.
taskRootDirectory	string	Katalog główny zadania zwolnienia zadania w węźle obliczeniowym. Za pomocą tej ścieżki można pobrać pliki utworzone przez zadanie, takie jak pliki dziennika.
taskRootDirectoryUrl	string	Adres URL do katalogu głównego zadania zwolnienia zadania w węźle obliczeniowym.

JobReleaseTaskState

Bieżący stan zadania zwolnienia zadania w węźle obliczeniowym.

Nazwa	Typ	Opis
completed	string	Zadanie zakończyło działanie z kodem zakończenia 0 lub zadanie wyczerpało limit ponawiania prób lub usługa Batch nie mogła uruchomić zadania z powodu błędów przygotowania zadania (takich jak błędy pobierania pliku zasobu).
running	string	Zadanie jest obecnie uruchomione (w tym ponawianie próby).

NameValuePair

Reprezentuje parę nazwa-wartość.

Nazwa	Typ	Opis
name	string	Nazwa w parze name-value.
value	string	Wartość w parze name-value.

TaskContainerExecutionInformation

Zawiera informacje o kontenerze, który wykonuje zadanie.

Nazwa	Typ	Opis
containerId	string	Identyfikator kontenera.
error	string	Szczegółowe informacje o błędzie dotyczące kontenera. Jest to szczegółowy ciąg błędu z usługi Docker, jeśli jest dostępny. Jest to odpowiednik pola błędu zwróconego przez wyrażenie "docker inspect".
state	string	Stan kontenera. Jest to stan kontenera zgodnie z usługą Docker. Jest to odpowiednik pola stanu zwróconego przez wyrażenie "docker inspect".

TaskExecutionResult

Wynik wykonania zadania.

Nazwa	Typ	Opis
failure	string	Wystąpił błąd podczas przetwarzania zadania. Błąd mógł wystąpić przed uruchomieniem procesu zadania, podczas wykonywania procesu zadania lub po zakończeniu procesu zadania.
success	string	Zadanie zakończyło się pomyślnie.

TaskFailureInformation

Informacje o niepowodzeniu zadania.

Nazwa	Typ	Opis
category	ErrorCategory	Kategoria błędu zadania.
code	string	Identyfikator błędu zadania. Kody są niezmienne i mają być używane programowo.
details	NameValuePair[]	Lista dodatkowych szczegółów związanych z błędem.
message	string	Komunikat opisujący błąd zadania, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.