Job - List Preparation And Release Task Status
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
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 |
---|---|---|---|---|
batch
|
path | True |
string |
Základní adresa URL pro všechny požadavky služby Azure Batch. |
job
|
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 | Vyžadováno | 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 |
Odpověď obsahující seznam stavů úloh přípravy a uvolnění úlohy. Hlavičky
|
|
Other Status Codes |
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
GET account.region.batch.azure.com/jobs/jobId/jobpreparationandreleasetaskstatus?api-version=2024-07-01.20.0
Ukázková odpověď
{
"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 |
---|---|
Batch |
Odpověď na chybu přijatá ze služby Azure Batch |
Batch |
Položka dalších informací zahrnutých v odpovědi na chybu služby Azure Batch |
Cloud |
Výsledek výpisu stavu úkolů přípravy úlohy a úkolů uvolnění úlohy pro úlohu. |
Error |
Kategorie chyby. |
Error |
V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva. |
Job |
Stav úkolů přípravy úlohy a uvolnění úlohy na výpočetním uzlu |
Job |
Obsahuje informace o provádění úlohy přípravy úlohy na výpočetním uzlu. |
Job |
Aktuální stav úlohy přípravy úlohy na výpočetním uzlu. |
Job |
Obsahuje informace o spuštění úlohy uvolnění úlohy na výpočetním uzlu. |
Job |
Aktuální stav úlohy uvolnění úlohy na výpočetním uzlu. |
Name |
Představuje dvojici název-hodnota. |
Task |
Obsahuje informace o kontejneru, který spouští úloha. |
Task |
Výsledek spuštění úlohy. |
Task |
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 |
Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní. |
|
values |
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 |
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 |
Informace o stavu provádění úlohy přípravy úlohy na tomto výpočetním uzlu. |
|
jobReleaseTaskExecutionInfo |
Informace o stavu spuštění úlohy uvolnění úlohy na tomto 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 |
Informace o kontejneru, pod kterým se úloha spouští. |
|
endTime |
string |
Čas dokončení úkolu přípravy úlohy. |
exitCode |
integer |
Ukončovací kód programu zadaný na příkazovém řádku Úkolu. |
failureInfo |
Informace popisující selhání úlohy ( pokud existuje). |
|
lastRetryTime |
string |
Poslední čas, kdy se spustil opakovaný pokus úlohy přípravy úlohy. |
result |
Výsledek provádění úlohy. |
|
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. |
startTime |
string |
Čas, kdy úloha začala běžet. |
state |
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 |
Informace o kontejneru, pod kterým se úloha spouští. |
|
endTime |
string |
Čas, kdy úloha uvolnění úlohy byla dokončena. |
exitCode |
integer |
Ukončovací kód programu zadaný na příkazovém řádku Úkolu. |
failureInfo |
Informace popisující selhání úlohy ( pokud existuje). |
|
result |
Výsledek provádění úlohy. |
|
startTime |
string |
Čas, kdy úloha začala běžet. |
state |
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 |
state |
string |
Stav kontejneru. |
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 |
Kategorie chyby úkolu. |
|
code |
string |
Identifikátor chyby úkolu. Kódy jsou invariantní a mají být využity programově. |
details |
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í. |