Job - List Preparation And Release Task Status

Reference

Služba:: Batch Service

Verze rozhraní API:: 2024-07-01.20.0

Vypíše stav spuštění úlohy přípravy úlohy a úlohy uvolnění úlohy pro zadanou úlohu ve výpočetních uzlech, ve kterých byla úloha spuštěna.
Toto rozhraní API vrátí stav úlohy přípravy a uvolnění úlohy na všech výpočetních uzlech, které mají spuštěnou úlohu přípravy úlohy nebo uvolnění úlohy. To zahrnuje výpočetní uzly, které byly od té doby odebrány z fondu. Pokud je toto rozhraní API vyvoláno u úlohy, která nemá žádnou úlohu přípravy úlohy nebo vydání úlohy, služba Batch vrátí stavový kód HTTP 409 (konflikt) s kódem chyby JobPreparationTaskNotSpecified.

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

S volitelnými parametry:

GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.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.
api-version	query	True	string	Verze rozhraní API klienta.
$filter	query		string	Klauzule $filter OData. Další informace o vytváření tohoto filtru naleznete v tématu https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status.
$select	query		string	Klauzule $select OData.
maxresults	query		integer int32	Maximální počet položek, které se mají vrátit v odpovědi. Může se vrátit maximálně 1 000 úkolů.
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

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

Name	Typ	Description
client-request-id	string uuid	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-rfc1123	Č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	CloudJobListPreparationAndReleaseTaskStatusResult	Odpověď obsahující seznam stavů úloh přípravy a uvolnění úlohy. Hlavičky client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Chyba ze služby Batch. Pokud je toto rozhraní API vyvoláno u úlohy, která nemá žádnou úlohu přípravy úlohy nebo vydání úlohy, služba Batch vrátí stavový kód HTTP 409.

Name

Typ

Description

200 OK

CloudJobListPreparationAndReleaseTaskStatusResult

Odpověď obsahující seznam stavů úloh přípravy a uvolnění úlohy.

Hlavičky

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

Other Status Codes

BatchError

Chyba ze služby Batch. Pokud je toto rozhraní API vyvoláno u úlohy, která nemá žádnou úlohu přípravy úlohy nebo vydání úlohy, služba Batch vrátí stavový kód HTTP 409.

Zabezpečení

azure_auth

Tok ověřovacího kódu Microsoft Entra OAuth 2.0

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

Rozsahy

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

Authorization

Typ: apiKey
V: header

Příklady

Job list preparation and release task status

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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"
}

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
CloudJobListPreparationAndReleaseTaskStatusResult	Výsledek výpisu stavu úkolů přípravy úlohy a úkolů uvolnění úlohy pro úlohu.
ErrorCategory	Kategorie chyby.
ErrorMessage	V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.
JobPreparationAndReleaseTaskExecutionInformation	Stav úkolů přípravy úlohy a uvolnění úlohy na výpočetním uzlu
JobPreparationTaskExecutionInformation	Obsahuje informace o provádění úlohy přípravy úlohy na výpočetním uzlu.
JobPreparationTaskState	Aktuální stav úlohy přípravy úlohy na výpočetním uzlu.
JobReleaseTaskExecutionInformation	Obsahuje informace o spuštění úlohy uvolnění úlohy na výpočetním uzlu.
JobReleaseTaskState	Aktuální stav úlohy uvolnění úlohy na výpočetním uzlu.
NameValuePair	Představuje dvojici název-hodnota.
TaskContainerExecutionInformation	Obsahuje informace o kontejneru, který spouští úloha.
TaskExecutionResult	Výsledek spuštění úlohy.
TaskFailureInformation	Informace o selhání úlohy

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

CloudJobListPreparationAndReleaseTaskStatusResult

Výsledek výpisu stavu úkolů přípravy úlohy a úkolů uvolnění úlohy pro úlohu.

Name	Typ	Description
odata.nextLink	string	Adresa URL pro získání další sady výsledků.
value	JobPreparationAndReleaseTaskExecutionInformation[]	Seznam informací o spuštění úlohy přípravy úlohy a vydání úlohy

ErrorCategory

Kategorie chyby.

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

ErrorMessage

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

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

JobPreparationAndReleaseTaskExecutionInformation

Stav úkolů přípravy úlohy a uvolnění úlohy na výpočetním uzlu

Name	Typ	Description
jobPreparationTaskExecutionInfo	JobPreparationTaskExecutionInformation	Informace o stavu provádění úlohy přípravy úlohy na tomto výpočetním uzlu.
jobReleaseTaskExecutionInfo	JobReleaseTaskExecutionInformation	Informace o stavu spuštění úlohy uvolnění úlohy na tomto výpočetním uzlu. Tato vlastnost je nastavena pouze v případě, že úloha uvolnění úlohy běží na výpočetním uzlu.
nodeId	string	ID výpočetního uzlu, na který tato položka odkazuje.
nodeUrl	string	Adresa URL výpočetního uzlu, na který tato položka odkazuje.
poolId	string	ID fondu obsahujícího výpočetní uzel, na který tato položka odkazuje.

JobPreparationTaskExecutionInformation

Obsahuje informace o provádění úlohy přípravy úlohy na výpočetním uzlu.

Name	Typ	Description
containerInfo	TaskContainerExecutionInformation	Informace o kontejneru, pod kterým se úloha spouští. Tato vlastnost je nastavena pouze v případě, že úloha běží v kontextu kontejneru.
endTime	string	Čas dokončení úkolu přípravy úlohy. Tato vlastnost je nastavena pouze v případě, že úkol je ve stavu Dokončeno.
exitCode	integer	Ukončovací kód programu zadaný na příkazovém řádku Úkolu. Tento parametr se vrátí pouze v případě, že je úkol v dokončeném stavu. 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. Všimněte si, že ukončovací kód může být také generován operačním systémem výpočetního uzlu, například při vynucení ukončení procesu.
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í.
lastRetryTime	string	Poslední čas, kdy se spustil opakovaný pokus úlohy přípravy úlohy. Tato vlastnost je nastavena pouze v případě, že došlo k opakování úkolu (tj. retryCount je nenulové). Pokud existuje, je to obvykle stejné jako startTime, ale může se lišit, pokud úloha byla restartována z jiných důvodů než opakování; Pokud se například během opakování restartoval výpočetní uzel, čas spuštění se aktualizuje, ale lastRetryTime není.
result	TaskExecutionResult	Výsledek provádění úlohy. Pokud je hodnota 'failed', pak podrobnosti o selhání lze najít ve vlastnosti failureInfo.
retryCount	integer	Počet opakování úlohy službou Batch Selhání aplikace úloh (nenulový ukončovací kód) se opakují, chyby předběžného zpracování (Úlohu nelze spustit) a chyby nahrávání souborů se neopakují. Služba Batch zopakuje úlohu až do limitu určeného omezeními. Selhání aplikace úloh (nenulový ukončovací kód) se opakují, chyby předběžného zpracování (Úlohu nelze spustit) a chyby nahrávání souborů se neopakují. Služba Batch zopakuje úlohu až do limitu určeného omezeními.
startTime	string	Čas, kdy úloha začala běžet. Pokud došlo k restartování nebo opakování úlohy, jedná se o nejnovější čas, kdy úloha začala běžet.
state	JobPreparationTaskState	Aktuální stav úlohy přípravy úlohy na výpočetním uzlu.
taskRootDirectory	string	Kořenový adresář úlohy přípravy úlohy na výpočetním uzlu. Tuto cestu můžete použít k načtení souborů vytvořených úlohou, jako jsou soubory protokolu.
taskRootDirectoryUrl	string	Adresa URL kořenového adresáře úlohy přípravy úlohy na výpočetním uzlu.

JobPreparationTaskState

Aktuální stav úlohy přípravy úlohy na výpočetním uzlu.

Name	Typ	Description
completed	string	Úloha se ukončila s ukončovacím kódem 0 nebo úloha vyčerpala limit opakování nebo služba Batch nemohla spustit úlohu kvůli chybám přípravy úkolů (například selhání stahování souborů prostředků).
running	string	Úloha je aktuálně spuštěná (včetně opakování).

JobReleaseTaskExecutionInformation

Obsahuje informace o spuštění úlohy uvolnění úlohy na výpočetním uzlu.

Name	Typ	Description
containerInfo	TaskContainerExecutionInformation	Informace o kontejneru, pod kterým se úloha spouští. Tato vlastnost je nastavena pouze v případě, že úloha běží v kontextu kontejneru.
endTime	string	Čas, kdy úloha uvolnění úlohy byla dokončena. Tato vlastnost je nastavena pouze v případě, že úkol je ve stavu Dokončeno.
exitCode	integer	Ukončovací kód programu zadaný na příkazovém řádku Úkolu. Tento parametr se vrátí pouze v případě, že je úkol v dokončeném stavu. 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. Všimněte si, že ukončovací kód může být také generován operačním systémem výpočetního uzlu, například při vynucení ukončení procesu.
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í.
result	TaskExecutionResult	Výsledek provádění úlohy. Pokud je hodnota 'failed', pak podrobnosti o selhání lze najít ve vlastnosti failureInfo.
startTime	string	Čas, kdy úloha začala běžet. Pokud došlo k restartování nebo opakování úlohy, jedná se o nejnovější čas, kdy úloha začala běžet.
state	JobReleaseTaskState	Aktuální stav úlohy uvolnění úlohy na výpočetním uzlu.
taskRootDirectory	string	Kořenový adresář úlohy uvolnění úlohy na výpočetním uzlu. Tuto cestu můžete použít k načtení souborů vytvořených úlohou, jako jsou soubory protokolu.
taskRootDirectoryUrl	string	Adresa URL kořenového adresáře úlohy uvolnění úlohy na výpočetním uzlu.

JobReleaseTaskState

Aktuální stav úlohy uvolnění úlohy na výpočetním uzlu.

Name	Typ	Description
completed	string	Úloha se ukončila s ukončovacím kódem 0 nebo úloha vyčerpala limit opakování nebo služba Batch nemohla spustit úlohu kvůli chybám přípravy úkolů (například selhání stahování souborů prostředků).
running	string	Úloha je aktuálně spuštěná (včetně opakování).

NameValuePair

Představuje dvojici název-hodnota.

Name	Typ	Description
name	string	Název v páru name-value.
value	string	Hodnota v páru name-value.

TaskContainerExecutionInformation

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

Name	Typ	Description
containerId	string	ID kontejneru.
error	string	Podrobné informace o chybě kontejneru Toto je podrobný řetězec chyby ze služby Docker, pokud je k dispozici. Odpovídá poli chyby vrácené kontrolou Dockeru.
state	string	Stav kontejneru. Toto je stav kontejneru podle služby Dockeru. Odpovídá poli stavu vráceného kontrolou Dockeru.

TaskExecutionResult

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

Name	Typ	Description
failure	string	Při zpracování úlohy došlo k chybě. K chybě 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 byla úspěšně spuštěna.

TaskFailureInformation

Informace o selhání úlohy

Name	Typ	Description
category	ErrorCategory	Kategorie chyby úkolu.
code	string	Identifikátor chyby úkolu. Kódy jsou invariantní a mají být využity 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í.

Sdílet prostřednictvím

Job - List Preparation And Release Task Status

Parametry identifikátoru URI

Hlavička požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Authorization

Příklady

Job list preparation and release task status

Ukázkový požadavek

Ukázková odpověď

Definice

BatchError

BatchErrorDetail

CloudJobListPreparationAndReleaseTaskStatusResult

ErrorCategory

ErrorMessage

JobPreparationAndReleaseTaskExecutionInformation

JobPreparationTaskExecutionInformation

JobPreparationTaskState

JobReleaseTaskExecutionInformation

JobReleaseTaskState

NameValuePair

TaskContainerExecutionInformation

TaskExecutionResult

TaskFailureInformation

Další materiály