Job - List Preparation And Release Task Status

Reference

Service:: Batch Service

API Version:: 2023-11-01.18.0

Uvádí stav spuštění úlohy přípravy úlohy a uvolnění úlohy pro zadanou úlohu na výpočetních uzlech, na kterých se úloha spustila.
Toto rozhraní API vrátí stav úlohy přípravy a uvolnění úlohy na všech výpočetních uzlech, na kterých je spuštěná úloha přípravy úlohy nebo úloha 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á úlohu přípravy úlohy ani úlohy uvolnění, vrátí služba Batch stavový kód HTTP 409 (Konflikt) s kódem chyby JobPreparationTaskNotSpecified.

GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?$filter={$filter}&$select={$select}&maxresults={maxresults}&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 Azure Batch služby.
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 najdete v tématu https://docs.microsoft.com/en-us/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í v odpovědi vrátit. Může se vrátit maximálně 1000 úkolů.
timeout	query		integer int32	Maximální doba, kterou 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	Typ	Description
client-request-id	string uuid	Identita požadavku vygenerovaná volajícím ve formě identifikátoru GUID bez dekorace, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Určuje, jestli má server v odpovědi vrátit client-request-id.
ocp-date	string date-time-rfc1123	Čas, kdy byla žádost vydána. Klientské knihovny obvykle nastavit na aktuální systémový čas hodin; pokud voláte rozhraní REST API přímo, explicitně ho nastavte.

Odpovědi

Name	Typ	Description
200 OK	CloudJobListPreparationAndReleaseTaskStatusResult	Odpověď obsahující seznam stavů úkolů přípravy úlohy a uvolnění úlohy. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Chyba ze služby Batch. Pokud se toto rozhraní API vyvolá u úlohy, která nemá úlohu přípravy úlohy ani úlohy uvolnění, vrátí služba Batch stavový kód HTTP 409.

Name

Typ

Description

200 OK

CloudJobListPreparationAndReleaseTaskStatusResult

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

Headers

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

Other Status Codes

BatchError

Chyba ze služby Batch. Pokud se toto rozhraní API vyvolá u úlohy, která nemá úlohu přípravy úlohy ani úlohy uvolnění, vrátí služba Batch stavový kód HTTP 409.

Zabezpečení

azure_auth

Microsoft Entra tok ověřovacího kódu 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

Job list preparation and release task status

Sample Request

HTTP

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

Sample Response

Status code:: 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=2023-11-01.18.0"
}

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.
CloudJobListPreparationAndReleaseTaskStatusResult	Výsledek výpisu stavu přípravných úloh a úkolů uvolnění úlohy pro úlohu.
ErrorCategory	Kategorie chyby.
ErrorMessage	Chybová zpráva přijatá v Azure Batch odpověď na chybu.
JobPreparationAndReleaseTaskExecutionInformation	Stav úloh přípravy úlohy a úkolů uvolnění úlohy na výpočetním uzlu
JobPreparationTaskExecutionInformation	Obsahuje informace o spuště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ý ú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.

CloudJobListPreparationAndReleaseTaskStatusResult

Výsledek výpisu stavu přípravných úloh 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 a uvolnění úlohy.

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.

JobPreparationAndReleaseTaskExecutionInformation

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

Name	Typ	Description
jobPreparationTaskExecutionInfo	JobPreparationTaskExecutionInformation	Informace o stavu spuště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 byla spuštěna 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 spuštění úlohy přípravy úlohy na výpočetním uzlu.

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 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 úlohy. Tento parametr je vrácen pouze v případě, že je úkol ve stavu dokončeno. Ukončovací kód procesu odráží konkrétní konvenci implementovanou vývojářem aplikace pro daný 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ém 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 spustilo opakování úlohy přípravy úlohy. Tato vlastnost je nastavena pouze v případě, že byl úkol zopakován (tj. retryCount je nenulový). Pokud je k dispozici, 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, aktualizuje se čas startTime, ale hodnota lastRetryTime ne.
result	TaskExecutionResult	Výsledek provedení úlohy. Pokud je hodnota "failed", podrobnosti o selhání lze najít ve vlastnosti failureInfo.
retryCount	integer	Počet opakování úlohy službou Batch. Neúspěš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 bude úlohu opakovat až do limitu určeného omezeními. Neúspěš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 bude úlohu opakovat až do limitu určeného omezeními.
startTime	string	Čas, kdy úloha začala běžet. Pokud se úloha restartovala nebo se zopakovala, jedná se o poslední čas, kdy se úloha spustila.
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říprava ú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 byla ukončena s ukončovacím kódem 0 nebo došlo k vyčerpání limitu opakování nebo službě Batch se nepodařilo spustit úkol kvůli chybám přípravy úkolu (například kvůli selhání stahování souboru zdroje).
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, 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 úloha uvolnění úlohy dokončila. 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 úlohy. Tento parametr je vrácen pouze v případě, že je úkol ve stavu dokončeno. Ukončovací kód procesu odráží konkrétní konvenci implementovanou vývojářem aplikace pro daný 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ém 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 provedení úlohy. Pokud je hodnota "failed", podrobnosti o selhání lze najít ve vlastnosti failureInfo.
startTime	string	Čas, kdy úloha začala běžet. Pokud se úloha restartovala nebo se zopakovala, jedná se o poslední čas, kdy se úloha spustila.
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 byla ukončena s ukončovacím kódem 0 nebo došlo k vyčerpání limitu opakování nebo službě Batch se nepodařilo spustit úkol kvůli chybám přípravy úkolu (například kvůli selhání stahování souboru zdroje).
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 ve dvojici název-hodnota.
value	string	Hodnota ve dvojici název-hodnota.

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

Job - List Preparation And Release Task Status

Parametry identifikátoru URI

Hlavička požadavku

Odpovědi

Zabezpečení

azure_auth

Scopes

Authorization

Příklady

Job list preparation and release task status

Sample Request

Sample Response

Definice

BatchError

BatchErrorDetail

CloudJobListPreparationAndReleaseTaskStatusResult

ErrorCategory

ErrorMessage

JobPreparationAndReleaseTaskExecutionInformation

JobPreparationTaskExecutionInformation

JobPreparationTaskState

JobReleaseTaskExecutionInformation

JobReleaseTaskState

NameValuePair

TaskContainerExecutionInformation

TaskExecutionResult

TaskFailureInformation

Další materiály