Tasks - List Sub Tasks

Uvádí všechny podúkoly spojené se specifikovaným víceinstancovým úkolem.
Pokud úkol není víceinsekvenční úkol, vrátí se prázdná kolekce.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
endpoint
path True

string (uri)

Koncový bod účtu Batch (například: https://batchaccount.eastus2.batch.azure.com).

jobId
path True

string

ID práce.

taskId
path True

string

ID úkolu.

api-version
query True

string

minLength: 1

Verze rozhraní API, která se má použít pro tuto operaci.

$select
query

string[]

Klauzule $select OData.

timeOut
query

integer (int32)

Maximální doba, po kterou může server strávit zpracováním požadavku v sekundách. Výchozí hodnota je 30 sekund. Pokud je hodnota větší než 30, použije se výchozí hodnota.".

Hlavička požadavku

Name Vyžadováno Typ Description
client-request-id

string

Identita požadavku vygenerovaná volajícím ve formě identifikátoru GUID bez dekorace, jako jsou složené závorky, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id

boolean

Určuje, jestli má server v odpovědi vrátit ID požadavku klienta.

ocp-date

string (date-time-rfc7231)

Čas vydání žádosti. Klientské knihovny obvykle nastavily aktuální systémový čas; explicitně ji nastavte, pokud voláte přímo rozhraní REST API.

Odpovědi

Name Typ Description
200 OK

BatchTaskListSubtasksResult

Požadavek byl úspěšný.

Hlavičky

  • ETag: string
  • Last-Modified: string
  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

Neočekávaná chybová odpověď

Zabezpečení

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Rozsahy

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

Příklady

Task list subtasks

Ukázkový požadavek

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


Ukázková odpověď

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

Definice

Name Description
BatchError

Odpověď na chybu přijatá ze služby Azure Batch

BatchErrorDetail

Položka dalších informací zahrnutých v odpovědi na chybu služby Azure Batch

BatchErrorMessage

V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.

BatchErrorSourceCategory

BatchErrorSourceCategory enumy

BatchNodeInfo

Informace o výpočetním uzlu, na kterém byla úloha spuštěna.

BatchSubtask

Informace o dílčím úkolu služby Azure Batch

BatchSubtaskState

Enums BatchSubtaskState

BatchTaskContainerExecutionInfo

Obsahuje informace o kontejneru, který spouští úloha.

BatchTaskExecutionResult

Enumy BatchTaskExecutionResult

BatchTaskFailureInfo

Informace o selhání úlohy

BatchTaskListSubtasksResult

Výsledek výpisu dílčích úkolů úkolu.

NameValuePair

Představuje dvojici název-hodnota.

BatchError

Odpověď na chybu přijatá ze služby Azure Batch

Name Typ Description
code

string

Identifikátor chyby. Kódy jsou invariantní a mají být využity programově.

message

BatchErrorMessage

Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.

values

BatchErrorDetail[]

Kolekce párů klíč-hodnota obsahující další podrobnosti o chybě.

BatchErrorDetail

Položka dalších informací zahrnutých v odpovědi na chybu služby Azure Batch

Name Typ Description
key

string

Identifikátor určující význam vlastnosti Value.

value

string

Další informace zahrnuté v odpovědi na chybu.

BatchErrorMessage

V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.

Name Typ Description
lang

string

Jazykový kód chybové zprávy.

value

string

Text zprávy.

BatchErrorSourceCategory

BatchErrorSourceCategory enumy

Hodnota Description
usererror

Chyba je způsobena uživatelským problémem, například špatnou konfigurací.

servererror

Chyba je způsobena interním serverovým problémem.

BatchNodeInfo

Informace o výpočetním uzlu, na kterém byla úloha spuštěna.

Name Typ Description
affinityId

string

Identifikátor uzlu, na kterém úkol běží, který lze předat při přidání úkolu k požadavku na naplánování úkolu na tomto výpočetním uzlu.

nodeId

string

ID Compute Node, na kterém úkol běžel.

nodeUrl

string (uri)

URL výpočetního uzlu, na kterém úkol běžel.

poolId

string

ID poolu, na kterém úkol běžel.

taskRootDirectory

string

Kořenový adresář úlohy na Compute Node.

taskRootDirectoryUrl

string (uri)

URL do kořenového adresáře úlohy na Compute Node.

BatchSubtask

Informace o dílčím úkolu služby Azure Batch

Name Typ Description
containerInfo

BatchTaskContainerExecutionInfo

Informace o kontejneru, ve kterém se úkol vykonává. Tato vlastnost je nastavena pouze tehdy, pokud Task běží v kontextu kontejneru.

endTime

string (date-time)

Čas, kdy byla dílčí úloha dokončena. Tato vlastnost je nastavena pouze tehdy, pokud je podúkol ve stavu Dokončeno.

exitCode

integer (int32)

Výstupní kód programu byl zadán v příkazovém řádku podúkolů. Tato vlastnost je nastavena pouze tehdy, pokud je podúkol ve stavu dokončení. Obecně výstupní kód procesu odráží specifickou konvenci implementovanou vývojářem aplikace pro daný proces. Pokud používáte hodnotu výstupního kódu k rozhodování ve svém kódu, ujistěte se, že znáte konvenci výstupního kódu, kterou aplikační proces používá. Pokud však služba Batch ukončí podúkol (kvůli časovému limitu nebo ukončení uživatele přes API), můžete vidět výstupní kód definovaný operačním systémem.

failureInfo

BatchTaskFailureInfo

Informace popisující selhání úkolu, pokud nějaké jsou. Tato vlastnost se nastaví pouze tehdy, pokud je úkol ve stavu dokončení a došlo k selhání.

id

integer (int32)

ID podúkolu.

nodeInfo

BatchNodeInfo

Informace o Compute Node, na kterém podúkol běžel.

previousState

BatchSubtaskState

Předchozí stav podúkolu. Tato vlastnost není nastavena, pokud je podúkol ve svém počátečním běžícím stavu.

previousStateTransitionTime

string (date-time)

Čas, kdy podúkol vstoupil do svého předchozího stavu. Tato vlastnost není nastavena, pokud je podúkol ve svém počátečním běžícím stavu.

result

BatchTaskExecutionResult

Výsledek provedení úkolu. Pokud je hodnota 'failed', podrobnosti o selhání lze najít ve vlastnosti failureInfo.

startTime

string (date-time)

Čas, kdy se podúkol začal spouštět. Pokud byla podúloha restartována nebo znovu vyzkoušena, jedná se o nejnovější spuštění podúkolu.

state

BatchSubtaskState

Současný stav podúkolu.

stateTransitionTime

string (date-time)

Čas, kdy podúkol vstoupil do svého současného stavu.

BatchSubtaskState

Enums BatchSubtaskState

Hodnota Description
preparing

Úkol byl přiřazen výpočetnímu uzlu, ale čeká na dokončení požadovaného úkolu přípravy úkolu na tomto výpočetním uzlu. Pokud úkol Příprava úkolu uspěje, úkol se přesune do běžícího režimu. Pokud úkol Přípravy úkolu selže, úkol se vrátí do aktivní režimu a bude způsobilý k přiřazení jinému výpočetnímu uzlu.

running

Úkol běží na Compute Node. To zahrnuje přípravu na úrovni úkolu, jako je stahování souborů zdrojů nebo nasazení balíčků specifikovaných v úkolu – to však nemusí nutně znamenat, že příkazový řádek úkolu již začal spouštět.

completed

Úkol již není způsobilý k vykonání, obvykle proto, že byl úspěšně dokončen, nebo úkol neúspěšně dokončen a vyčerpal svůj limit pro opakované pokusy. Úkol je také označen jako dokončený, pokud došlo k chybě při spuštění úkolu nebo pokud byl úkol ukončen.

BatchTaskContainerExecutionInfo

Obsahuje informace o kontejneru, který spouští úloha.

Name Typ Description
containerId

string

ID kontejneru.

error

string

Podrobné informace o chybách kontejneru. Toto je podrobný chybový řetězec ze služby Docker, pokud je k dispozici. Je ekvivalentní chybovému poli vrácenému "docker inspect".

state

string

Stav kontejneru. Toto je stav kontejneru podle služby Docker. Je ekvivalentní statusovému poli vrácenému "docker inspect".

BatchTaskExecutionResult

Enumy BatchTaskExecutionResult

Hodnota Description
success

Úkol proběhl úspěšně.

failure

Při zpracování úkolu došlo k chybě. Selhání mohlo nastat před spuštěním procesu Úkolu, během jeho spuštění, nebo po jeho ukončení.

BatchTaskFailureInfo

Informace o selhání úlohy

Name Typ Description
category

BatchErrorSourceCategory

Kategorie chyby Task.

code

string

Identifikátor pro chybu Task. Kódy jsou invariantní a mají být využity programově.

details

NameValuePair[]

Seznam dalších detailů týkajících se chyby.

message

string

Zpráva popisující chybu Task, určená k zobrazení v uživatelském rozhraní.

BatchTaskListSubtasksResult

Výsledek výpisu dílčích úkolů úkolu.

Name Typ Description
odata.nextLink

string (uri)

Adresa URL pro získání další sady výsledků.

value

BatchSubtask[]

Seznam vedlejších úkolů.

NameValuePair

Představuje dvojici název-hodnota.

Name Typ Description
name

string

Jméno v páru jméno-hodnota.

value

string

Hodnota v páru jméno-hodnota.