Tasks - List Sub Tasks

Usługa:: Batch Service

Wersja interfejsu API:: 2025-06-01

Lista wszystkich podzadań powiązanych z określonym zadaniem wieloinstancyjnym.
Jeśli zadanie nie jest zadaniem wieloinstancyjnym, to zwraca się pusta kolekcja.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string (uri)	Punkt końcowy konta usługi Batch (na przykład: https://batchaccount.eastus2.batch.azure.com).
jobId	path	True	string	Identyfikacja stanowiska.
taskId	path	True	string	Identyfikator zadania.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.
$select	query		string[]	Klauzula OData $select.
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 domyślna wersja domyślna.".

Nagłówek żądania

Nazwa	Typ	Opis
client-request-id	string	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-rfc7231)	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	BatchTaskListSubtasksResult	Żądanie zakończyło się pomyślnie. Nagłówki ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Nieoczekiwana odpowiedź na błąd.

Nazwa

Typ

Opis

200 OK

BatchTaskListSubtasksResult

Żądanie zakończyło się pomyślnie.

Nagłówki

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

Other Status Codes

BatchError

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

OAuth2Auth

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

Zakresy

Nazwa	Opis
https://batch.core.windows.net//.default

Przykłady

Task list subtasks

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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"
      }
    }
  ]
}

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.
BatchErrorMessage	Komunikat o błędzie odebrany w odpowiedzi na błąd usługi Azure Batch.
BatchErrorSourceCategory	Enumy BatchErrorSourceCategory
BatchNodeInfo	Informacje o węźle obliczeniowym, na którym uruchomiono zadanie.
BatchSubtask	Informacje o podzadanie usługi Azure Batch.
BatchSubtaskState	Enums BatchSubtaskState
BatchTaskContainerExecutionInfo	Zawiera informacje o kontenerze, który wykonuje zadanie.
BatchTaskExecutionResult	Enumy BatchTaskExecutionResult
BatchTaskFailureInfo	Informacje o niepowodzeniu zadania.
BatchTaskListSubtasksResult	Wynik wyświetlania listy podzadań zadania.
NameValuePair	Reprezentuje parę nazwa-wartość.

BatchError

Objekt

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

Objekt

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.

BatchErrorMessage

Objekt

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

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

BatchErrorSourceCategory

Wyliczenie

Enumy BatchErrorSourceCategory

Wartość	Opis
usererror	Błąd wynika z problemu użytkownika, na przykład z błędnej konfiguracji.
servererror	Błąd wynika z wewnętrznego problemu z serwerem.

BatchNodeInfo

Objekt

Informacje o węźle obliczeniowym, na którym uruchomiono zadanie.

Nazwa	Typ	Opis
affinityId	string	Identyfikator węzła, na którym działało zadanie, który można przekazać podczas dodawania zadania, aby zażądać zaplanowania zadania na tym węźle obliczeniowym.
nodeId	string	ID węzła obliczeniowego, na którym działało zadanie.
nodeUrl	string (uri)	URL węzła obliczeniowego, na którym działało zadanie.
poolId	string	ID puli, na której działało zadanie.
taskRootDirectory	string	Katalog główny zadania na węźle obliczeniowym.
taskRootDirectoryUrl	string (uri)	URL do katalogu głównego zadania na węźle obliczeniowym.

BatchSubtask

Objekt

Informacje o podzadanie usługi Azure Batch.

Nazwa	Typ	Opis
containerInfo	BatchTaskContainerExecutionInfo	Informacje o kontenerze, w którym wykonywane jest zadanie. Ta właściwość jest ustawiona tylko wtedy, gdy zadanie działa w kontekście kontenerowym.
endTime	string (date-time)	Czas, w którym podzadanie zostało ukończone. Ta właściwość jest ustawiona tylko wtedy, gdy podzadanie znajduje się w stanie Zakończone.
exitCode	integer (int32)	Kod wyjścia programu określony w wierszu poleceń podzadania. Ta właściwość jest ustawiana tylko wtedy, gdy podzadanie znajduje się w stanie zakończonym. Ogólnie rzecz biorąc, kod wyjścia dla procesu odzwierciedla konkretną konwencję zaimplementowaną przez twórcę aplikacji dla tego procesu. Jeśli używasz wartości kodu wyjścia do podejmowania decyzji w kodzie, upewnij się, że znasz konwencję kodu wyjścia stosowaną przez proces aplikacji. Jednak jeśli usługa Batch zakończy podzadanie (z powodu limitu czasu lub zakończenia użytkownika przez API), możesz zobaczyć kod wyjścia zdefiniowany przez system operacyjny.
failureInfo	BatchTaskFailureInfo	Informacje opisujące ewentualne niepowodzenie zadania. Ta właściwość jest ustawiona tylko wtedy, gdy zadanie jest w stanie ukończonym i napotkało awarię.
id	integer (int32)	ID podzadania.
nodeInfo	BatchNodeInfo	Informacje o węźle Compute, na którym działało podzadanie.
previousState	BatchSubtaskState	Poprzedni stan podzadania. Ta właściwość nie jest ustalana, jeśli podzadanie znajduje się w początkowym stanie działania.
previousStateTransitionTime	string (date-time)	Czas, w którym podzadanie weszło w poprzedni stan. Ta właściwość nie jest ustalana, jeśli podzadanie znajduje się w początkowym stanie działania.
result	BatchTaskExecutionResult	Wynik wykonania zadania. Jeśli wartość to 'failed', szczegóły awarii można znaleźć w właściwości failureInfo.
startTime	string (date-time)	Moment, w którym podzadanie zaczęło działać. Jeśli podzadanie zostało ponownie uruchomione lub wypróbowane, jest to najnowszy moment, kiedy zaczęło się uruchamiać.
state	BatchSubtaskState	Obecny stan podzadania.
stateTransitionTime	string (date-time)	Moment, w którym podzadanie weszło w obecny stan.

BatchSubtaskState

Wyliczenie

Enums BatchSubtaskState

Wartość	Opis
preparing	Zadanie zostało przypisane do węzła obliczeniowego, ale czeka na wykonanie wymaganego zadania przygotowania zadania na tym węźle. Jeśli zadanie Przygotowania Zadania zakończy się sukcesem, przechodzi do działania. Jeśli zadanie Przygotowania Zadania nie powiedzie, Zadanie powróci do aktywnego stanu i będzie kwalifikować się do przypisania do innego węzła obliczeniowego.
running	Zadanie jest uruchamiane na węźle obliczeniowym. Obejmuje to przygotowanie na poziomie zadania, takie jak pobieranie plików zasobów czy wdrażanie pakietów określonych w zadaniu – nie oznacza to koniecznie, że linia poleceń zadania rozpoczęła działanie.
completed	Zadanie nie może już zostać wykonane, zazwyczaj dlatego, że zadanie zakończyło się pomyślnie lub zadanie zakończyło się niepowodzeniem i wyczerpało limit powtórek. Zadanie jest również oznaczane jako zakończone, jeśli wystąpił błąd podczas jego uruchomienia lub gdy zadanie zostało zakończone.

BatchTaskContainerExecutionInfo

Objekt

Zawiera informacje o kontenerze, który wykonuje zadanie.

Nazwa	Typ	Opis
containerId	string	Identyfikacja kontenera.
error	string	Szczegółowe informacje o błędach dotyczących kontenera. To jest szczegółowy ciąg błędów z usługi Docker, jeśli jest dostępny. Jest równoważne polu błędu zwracanemu przez "docker inspect".
state	string	Stan pojemnika. Taki jest stan kontenera według usługi Docker. Jest to równoważne polu statusu zwracanemu przez "docker inspect".

BatchTaskExecutionResult

Wyliczenie

Enumy BatchTaskExecutionResult

Wartość	Opis
success	Zadanie przebiegło pomyślnie.
failure	Podczas przetwarzania zadania wystąpił błąd. Awaria mogła nastąpić przed uruchomieniem procesu Zadania, podczas jego wykonywania lub po jego zakończeniu.

BatchTaskFailureInfo

Objekt

Informacje o niepowodzeniu zadania.

Nazwa	Typ	Opis
category	BatchErrorSourceCategory	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 tym błędem.
message	string	Komunikat opisujący błąd zadania, przeznaczony do wyświetlania w interfejsie użytkownika.

BatchTaskListSubtasksResult

Objekt

Wynik wyświetlania listy podzadań zadania.

Nazwa	Typ	Opis
odata.nextLink	string (uri)	Adres URL, aby uzyskać następny zestaw wyników.
value	BatchSubtask[]	Lista podzadań.

NameValuePair

Objekt

Reprezentuje parę nazwa-wartość.

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

Udostępnij za pośrednictwem

Tasks - List Sub Tasks

Parametry identyfikatora URI

Nagłówek żądania

Odpowiedzi

Zabezpieczenia

OAuth2Auth

Zakresy

Przykłady

Task list subtasks

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

BatchError

BatchErrorDetail

BatchErrorMessage

BatchErrorSourceCategory

BatchNodeInfo

BatchSubtask

BatchSubtaskState

BatchTaskContainerExecutionInfo

BatchTaskExecutionResult

BatchTaskFailureInfo

BatchTaskListSubtasksResult

NameValuePair