Task - List Subtasks

Reference

Service:: Batch Service

API Version:: 2023-11-01.18.0

Zobrazí seznam všech dílčích úkolů přidružených k zadané úloze s více instancemi.
Pokud úloha není úlohou s více instancemi, vrátí se prázdná kolekce.

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/subtasksinfo?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/subtasksinfo?$select={$select}&timeout={timeout}&api-version=2023-11-01.18.0

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
batchUrl	path	True	string	Základní adresa URL pro všechny požadavky služby Azure Batch.
jobId	path	True	string	ID úlohy.
taskId	path	True	string	ID úkolu.
api-version	query	True	string	Verze klientského rozhraní API.
$select	query		string	Klauzule $select OData.
timeout	query		integer int32	Maximální čas, který může server strávit zpracováním požadavku, v sekundách. Výchozí hodnota je 30 sekund.

Hlavička požadavku

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

Name	Vyžadováno	Typ	Description
client-request-id		string uuid	Identita požadavku vygenerovaná volajícím ve formě identifikátoru GUID bez ozdob, jako jsou složené závorky, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Jestli má server v odpovědi vrátit client-request-id.
ocp-date		string date-time-rfc1123	Čas, kdy byla žádost vystavena. Klientské knihovny obvykle tuto možnost nastaví na aktuální systémový čas. pokud přímo voláte rozhraní REST API, nastavte ho explicitně.

Odpovědi

Name

Typ

Description

200 OK

CloudTaskListSubtasksResult

Odpověď obsahující seznam dílčích úkolů.

Headers

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

Other Status Codes

Chyba ze služby Batch.

Zabezpečení

azure_auth

Microsoft Entra tok kódu ověřování OAuth 2.0

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Zosobnění uživatelského účtu

Authorization

Type: apiKey
In: header

Příklady

Task list subtasks

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": 1,
      "startTime": "2016-09-06T06:59:16.3139271Z",
      "endTime": "2016-09-06T06:59:20.0242024Z",
      "state": "completed",
      "stateTransitionTime": "2016-09-06T06:59:20.0242024Z",
      "previousState": "running",
      "previousStateTransitionTime": "2016-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": "2016-09-06T06:59:16.9702844Z",
      "state": "running",
      "stateTransitionTime": "2016-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	Ze služby Azure Batch byla přijata chybová odpověď.
BatchErrorDetail	Položka s dalšími informacemi, které jsou součástí Azure Batch odpovědi na chybu.
CloudTaskListSubtasksResult	Výsledek výpisu dílčích úkolů úkolu.
ComputeNodeInformation	Informace o výpočetním uzlu, na kterém úloha běžela.
ErrorCategory	Kategorie chyby.
ErrorMessage	Chybová zpráva přijatá v Azure Batch odpověď na chybu.
NameValuePair	Představuje dvojici název-hodnota.
SubtaskInformation	Informace o dílčím úkolu Azure Batch
SubtaskState	Stav dílčího úkolu.
TaskContainerExecutionInformation	Obsahuje informace o kontejneru, který úloha provádí.
TaskExecutionResult	Výsledek spuštění úlohy.
TaskFailureInformation	Informace o selhání úlohy

BatchError

Ze služby Azure Batch byla přijata chybová odpověď.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využívány programově.
message	ErrorMessage	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 s dalšími informacemi, které jsou součástí Azure Batch odpovědi na chybu.

Name	Typ	Description
key	string	Identifikátor určující význam vlastnosti Value.
value	string	Další informace zahrnuté v chybové odpovědi.

CloudTaskListSubtasksResult

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

Name	Typ	Description
value	SubtaskInformation[]	Seznam dílčích úkolů.

ComputeNodeInformation

Informace o výpočetním uzlu, na kterém úloha běžela.

Name	Typ	Description
affinityId	string	Identifikátor uzlu, na kterém úloha běžela, který může být předán při přidávání úlohy, která vyžaduje, aby byla úloha naplánovaná na tomto výpočetním uzlu.
nodeId	string	ID výpočetního uzlu, na kterém úloha běžela.
nodeUrl	string	Adresa URL výpočetního uzlu, na kterém úloha běžela.
poolId	string	ID fondu, ve kterém se úloha spustila.
taskRootDirectory	string	Kořenový adresář úlohy na výpočetním uzlu.
taskRootDirectoryUrl	string	Adresa URL kořenového adresáře úlohy na výpočetním uzlu.

ErrorCategory

Kategorie chyby.

Name	Typ	Description
servererror	string	Příčinou chyby je interní problém se serverem.
usererror	string	Příčinou chyby je problém s uživatelem, například chybná konfigurace.

ErrorMessage

Chybová zpráva přijatá v Azure Batch odpověď na chybu.

Name	Typ	Description
lang	string	Kód jazyka chybové zprávy
value	string	Text zprávy.

NameValuePair

Představuje dvojici název-hodnota.

Name	Typ	Description
name	string	Název ve dvojici název-hodnota.
value	string	Hodnota ve dvojici název-hodnota.

SubtaskInformation

Informace o dílčím úkolu Azure Batch

Name	Typ	Description
containerInfo	TaskContainerExecutionInformation	Informace o kontejneru, ve kterém se úloha spouští. Tato vlastnost je nastavena pouze v případě, že úloha běží v kontextu kontejneru.
endTime	string	Čas, kdy se dílčí úkol dokončil. Tato vlastnost je nastavena pouze v případě, že dílčí úkol je ve stavu Dokončeno.
exitCode	integer	Ukončovací kód programu zadaný na příkazovém řádku dílčího úkolu. Tato vlastnost je nastavena pouze v případě, že je dílčí úkol v dokončeném stavu. Obecně platí, že ukončovací kód procesu odráží konkrétní konvenci implementovanou vývojářem aplikace pro tento proces. Pokud k rozhodování v kódu použijete hodnotu ukončovacího kódu, ujistěte se, že znáte konvenci ukončovacího kódu používanou procesem aplikace. Pokud však služba Batch ukončí dílčí úkol (kvůli vypršení časového limitu nebo ukončení uživatele prostřednictvím rozhraní API), může se zobrazit ukončovací kód definovaný operačním systémem.
failureInfo	TaskFailureInformation	Informace popisující selhání úlohy, pokud existuje. Tato vlastnost je nastavena pouze v případě, že úkol je v dokončeném stavu a došlo k selhání.
id	integer	ID dílčího úkolu.
nodeInfo	ComputeNodeInformation	Informace o výpočetním uzlu, na kterém se dílčí úkol spustil.
previousState	SubtaskState	Předchozí stav dílčího úkolu. Tato vlastnost není nastavena, pokud je dílčí úkol v počátečním stavu.
previousStateTransitionTime	string	Čas, kdy dílčí úkol vstoupil do předchozího stavu. Tato vlastnost není nastavena, pokud je dílčí úkol v počátečním stavu.
result	TaskExecutionResult	Výsledek provedení úlohy. Pokud je hodnota "failed", podrobnosti o selhání lze najít ve vlastnosti failureInfo.
startTime	string	Čas, kdy dílčí úkol začal běžet. Pokud se dílčí úkol restartoval nebo se zopakoval, jedná se o poslední čas, kdy dílčí úkol začal běžet.
state	SubtaskState	Aktuální stav dílčího úkolu.
stateTransitionTime	string	Čas, kdy dílčí úkol vstoupil do aktuálního stavu.

SubtaskState

Stav dílčího úkolu.

Name	Typ	Description
completed	string	Úkol již není způsobilý ke spuštění, obvykle proto, že úkol byl úspěšně dokončen nebo úkol skončil neúspěšně a vyčerpal limit opakování. Úkol je také označen jako dokončený, pokud došlo k chybě při spuštění úkolu nebo když byl úkol ukončen.
preparing	string	Úkol byl přiřazen výpočetnímu uzlu, ale čeká na dokončení požadovaného úkolu přípravy úlohy na výpočetním uzlu. Pokud je úloha přípravy úlohy úspěšná, přesune se na spuštěnou. Pokud úloha přípravy úlohy selže, úkol se vrátí do aktivního a bude mít nárok na přiřazení k jinému výpočetnímu uzlu.
running	string	Úloha běží na výpočetním uzlu. To zahrnuje přípravu na úrovni úkolů, jako je stahování souborů zdrojů nebo nasazení balíčků zadaných na úkolu – nemusí to nutně znamenat, že se spustil příkazový řádek úkolu.

TaskContainerExecutionInformation

Obsahuje informace o kontejneru, který úloha provádí.

Name	Typ	Description
containerId	string	ID kontejneru.
error	string	Podrobné informace o chybě o kontejneru Toto je podrobný řetězec chyby ze služby Dockeru, pokud je k dispozici. Je ekvivalentní chybovému poli, které vrátil docker inspect.
state	string	Stav kontejneru. Toto je stav kontejneru podle služby Dockeru. Je ekvivalentní poli stavu, které vrátil docker inspect.

TaskExecutionResult

Výsledek spuštění úlohy.

Name	Typ	Description
failure	string	Při zpracování úlohy došlo k chybě. K selhání mohlo dojít před spuštěním procesu úkolu, během provádění procesu úkolu nebo po ukončení procesu úkolu.
success	string	Úloha se úspěšně spustila.

TaskFailureInformation

Informace o selhání úlohy

Name	Typ	Description
category	ErrorCategory	Kategorie chyby Úlohy.
code	string	Identifikátor chyby úlohy. Kódy jsou invariantní a mají být využívány programově.
details	NameValuePair[]	Seznam dalších podrobností souvisejících s chybou
message	string	Zpráva popisující chybu Úlohy, která má být vhodná pro zobrazení v uživatelském rozhraní.