Job - List Preparation And Release Task Status

A megadott feladat feladat-előkészítési és feladatkiadási tevékenységének végrehajtási állapotát sorolja fel azon számítási csomópontokon, ahol a feladat futott.
Ez az API visszaadja a feladat-előkészítési és feladatkiadási tevékenység állapotát minden olyan számítási csomóponton, amely futtatja a feladat-előkészítési vagy feladatkiadási tevékenységet. Ide tartoznak azok a számítási csomópontok, amelyeket azóta eltávolítottak a készletből. Ha ezt az API-t olyan feladaton hívja meg, amely nem rendelkezik feladat-előkészítési vagy feladatkiadási tevékenységgel, a Batch szolgáltatás a 409-es (ütközési) HTTP-állapotkódot adja vissza JobPreparationTaskNotSpecified hibakóddal.

GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?api-version=2023-11-01.18.0
GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

URI-paraméterek

Name In Kötelező Típus Description
batchUrl
path True

string

Az összes Azure Batch szolgáltatáskérés alap URL-címe.

jobId
path True

string

A feladat azonosítója.

api-version
query True

string

Ügyfél API-verziója.

$filter
query

string

Egy OData $filter záradék. A szűrő felépítésével kapcsolatos további információkért lásd: https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status.

$select
query

string

Egy OData $select záradék.

maxresults
query

integer

int32

A válaszban visszaadandó elemek maximális száma. Legfeljebb 1000 feladat adható vissza.

timeout
query

integer

int32

A kérés feldolgozásának maximális időtartama másodpercben. Az alapértelmezett érték 30 mp.

Kérelem fejléce

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

Name Kötelező Típus Description
client-request-id

string

uuid

A hívó által generált kérési identitás, olyan GUID formátumban, amely nem rendelkezik díszítéssel, például kapcsos zárójelekkel, például 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id

boolean

Azt határozza meg, hogy a kiszolgálónak vissza kell-e küldenie a válaszban szereplő client-request-id azonosítót.

ocp-date

string

date-time-rfc1123

A kérelem kiállításának időpontja. Az ügyfélkódtárak ezt általában az aktuális rendszeróraidőre állítják be; állítsa be explicit módon, ha a REST API-t közvetlenül hívja meg.

Válaszok

Name Típus Description
200 OK

CloudJobListPreparationAndReleaseTaskStatusResult

A feladat-előkészítési és a feladatkiadási tevékenységállapotok listáját tartalmazó válasz.

Headers

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

BatchError

A Batch szolgáltatás hibája. Ha ezt az API-t olyan feladaton hívja meg, amely nem rendelkezik feladat-előkészítési vagy feladatkiadási feladattal, a Batch szolgáltatás a 409-es HTTP-állapotkódot adja vissza.

Biztonság

azure_auth

Microsoft Entra OAuth 2.0 hitelesítési kódfolyamata

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

Scopes

Name Description
user_impersonation A felhasználói fiók megszemélyesítése

Authorization

Type: apiKey
In: header

Példák

Job list preparation and release task status

Sample Request

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


Sample Response

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

Definíciók

Name Description
BatchError

A Azure Batch szolgáltatástól kapott hibaválasz.

BatchErrorDetail

A Azure Batch hibaválaszban szereplő további információk egy eleme.

CloudJobListPreparationAndReleaseTaskStatusResult

Egy feladat feladat-előkészítési és feladat-kiadási feladatainak állapotának listázásának eredménye.

ErrorCategory

A hiba kategóriája.

ErrorMessage

Hibaüzenet érkezett egy Azure Batch hibaválaszban.

JobPreparationAndReleaseTaskExecutionInformation

A számítási csomópont feladat-előkészítési és feladatkiadási feladatainak állapota.

JobPreparationTaskExecutionInformation

A számítási csomópont feladat-előkészítési feladatának végrehajtásával kapcsolatos információkat tartalmazza.

JobPreparationTaskState

A számítási csomópont feladat-előkészítési tevékenységének aktuális állapota.

JobReleaseTaskExecutionInformation

A számítási csomóponton lévő feladatkiadási feladat végrehajtásával kapcsolatos információkat tartalmaz.

JobReleaseTaskState

A számítási csomópont feladatkiadási tevékenységének aktuális állapota.

NameValuePair

Név-érték párokat jelöl.

TaskContainerExecutionInformation

Információkat tartalmaz arról a tárolóról, amelyet egy feladat hajt végre.

TaskExecutionResult

A feladat végrehajtásának eredménye.

TaskFailureInformation

A feladathibával kapcsolatos információk.

BatchError

A Azure Batch szolgáltatástól kapott hibaválasz.

Name Típus Description
code

string

A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.

message

ErrorMessage

A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.

values

BatchErrorDetail[]

Kulcs-érték párok gyűjteménye, amely további részleteket tartalmaz a hibáról.

BatchErrorDetail

A Azure Batch hibaválaszban szereplő további információk egy eleme.

Name Típus Description
key

string

Az Érték tulajdonság jelentését meghatározó azonosító.

value

string

A hibaválaszban szereplő további információk.

CloudJobListPreparationAndReleaseTaskStatusResult

Egy feladat feladat-előkészítési és feladat-kiadási feladatainak állapotának listázásának eredménye.

Name Típus Description
odata.nextLink

string

A következő eredményhalmaz lekéréséhez tartozó URL-cím.

value

JobPreparationAndReleaseTaskExecutionInformation[]

A feladat-előkészítési és a feladatkiadási feladat végrehajtási adatainak listája.

ErrorCategory

A hiba kategóriája.

Name Típus Description
servererror

string

A hiba belső kiszolgálóhiba miatt van.

usererror

string

A hiba egy felhasználói probléma, például a helytelen konfiguráció miatt merült fel.

ErrorMessage

Hibaüzenet érkezett egy Azure Batch hibaválaszban.

Name Típus Description
lang

string

A hibaüzenet nyelvkódja

value

string

Az üzenet szövege.

JobPreparationAndReleaseTaskExecutionInformation

A számítási csomópont feladat-előkészítési és feladatkiadási feladatainak állapota.

Name Típus Description
jobPreparationTaskExecutionInfo

JobPreparationTaskExecutionInformation

Információk a számítási csomópont feladat-előkészítési feladatának végrehajtási állapotáról.

jobReleaseTaskExecutionInfo

JobReleaseTaskExecutionInformation

Információk a számítási csomópont feladatkiadási feladatának végrehajtási állapotáról.
Ez a tulajdonság csak akkor van beállítva, ha a feladatkiadási feladat a számítási csomóponton fut.

nodeId

string

Annak a számítási csomópontnak az azonosítója, amelyre ez a bejegyzés hivatkozik.

nodeUrl

string

Annak a számítási csomópontnak az URL-címe, amelyre ez a bejegyzés hivatkozik.

poolId

string

Annak a készletnek az azonosítója, amely tartalmazza azt a számítási csomópontot, amelyre ez a bejegyzés hivatkozik.

JobPreparationTaskExecutionInformation

A számítási csomópont feladat-előkészítési feladatának végrehajtásával kapcsolatos információkat tartalmazza.

Name Típus Description
containerInfo

TaskContainerExecutionInformation

Információ arról a tárolóról, amely alatt a feladat fut.
Ez a tulajdonság csak akkor van beállítva, ha a feladat tárolókörnyezetben fut.

endTime

string

A feladat-előkészítési feladat befejezésének időpontja.
Ez a tulajdonság csak akkor van beállítva, ha a Tevékenység Befejezve állapotban van.

exitCode

integer

A Tevékenység parancssorban megadott program kilépési kódja.
Ez a paraméter csak akkor lesz visszaadva, ha a Tevékenység befejezett állapotban van. A folyamat kilépési kódja az alkalmazás fejlesztője által a folyamathoz implementált konkrét konvenciót tükrözi. Ha a kilépési kód értékével hoz döntéseket a kódban, győződjön meg arról, hogy ismeri az alkalmazásfolyamat által használt kilépési kód konvenciót. Vegye figyelembe, hogy a kilépési kódot a számítási csomópont operációs rendszere is létrehozhatja, például amikor egy folyamat kényszerített módon leáll.

failureInfo

TaskFailureInformation

A feladathibát leíró információk, ha vannak ilyenek.
Ez a tulajdonság csak akkor van beállítva, ha a tevékenység befejezett állapotban van, és hibát észlelt.

lastRetryTime

string

A legutóbbi időpont, amikor a feladat-előkészítési feladat újrapróbálkozása elkezdődött.
Ez a tulajdonság csak akkor van beállítva, ha a tevékenységet újrapróbálták (azaz a retryCount nem ero). Ha ez jelen van, ez általában megegyezik a startTime-zal, de eltérő lehet, ha a tevékenységet az újrapróbálkozáson kívül más okból újraindították; Ha például a számítási csomópont újraindult egy újrapróbálkozás során, akkor a startTime frissül, de a lastRetryTime nem.

result

TaskExecutionResult

A feladat végrehajtásának eredménye.
Ha az érték "failed", akkor a hiba részletei megtalálhatók a failureInfo tulajdonságban.

retryCount

integer

Az a szám, amikor a Batch szolgáltatás újrapróbálkozott a feladattal. A rendszer újrapróbálkozott a feladatalkalmazás hibáival (nem nulla kilépési kóddal), előfeldolgozási hibák (a feladat nem futtatható), és a fájlfeltöltési hibák nem lesznek újrapróbálkozva. A Batch szolgáltatás a kényszerek által megadott korlátig újra megpróbálja végrehajtani a feladatot.
A rendszer újrapróbálkozott a feladatalkalmazás hibáival (nem nulla kilépési kóddal), előfeldolgozási hibák (a feladat nem futtatható), és a fájlfeltöltési hibák nem lesznek újrapróbálkozva. A Batch szolgáltatás a kényszerek által megadott korlátig újra megpróbálja végrehajtani a feladatot.

startTime

string

A tevékenység futásának időpontja.
Ha a tevékenység újraindult vagy újrapróbálkozott, akkor ez a legutóbbi időpont, amikor a tevékenység elindult.

state

JobPreparationTaskState

A számítási csomópont feladat-előkészítési tevékenységének aktuális állapota.

taskRootDirectory

string

A számítási csomópont feladat-előkészítési feladatának gyökérkönyvtára. Ezzel az elérési úttal lekérheti a tevékenység által létrehozott fájlokat, például naplófájlokat.

taskRootDirectoryUrl

string

A számítási csomópont feladat-előkészítési feladatának gyökérkönyvtárának URL-címe.

JobPreparationTaskState

A számítási csomópont feladat-előkészítési tevékenységének aktuális állapota.

Name Típus Description
completed

string

A tevékenység a 0-s kilépési kóddal lépett ki, vagy a tevékenység kimerítette az újrapróbálkozási korlátot, vagy a Batch szolgáltatás nem tudta elindítani a feladatot a tevékenység előkészítésével kapcsolatos hibák (például az erőforrásfájl letöltési hibái) miatt.

running

string

A feladat jelenleg fut (beleértve az újrapróbálkozást is).

JobReleaseTaskExecutionInformation

A számítási csomóponton lévő feladatkiadási feladat végrehajtásával kapcsolatos információkat tartalmaz.

Name Típus Description
containerInfo

TaskContainerExecutionInformation

Információ arról a tárolóról, amely alatt a feladat fut.
Ez a tulajdonság csak akkor van beállítva, ha a feladat tárolókörnyezetben fut.

endTime

string

A feladatkiadási feladat befejezésének időpontja.
Ez a tulajdonság csak akkor van beállítva, ha a Tevékenység Befejezve állapotban van.

exitCode

integer

A Tevékenység parancssorban megadott program kilépési kódja.
Ez a paraméter csak akkor lesz visszaadva, ha a Tevékenység befejezett állapotban van. A folyamat kilépési kódja az alkalmazás fejlesztője által a folyamathoz implementált konkrét konvenciót tükrözi. Ha a kilépési kód értékével hoz döntéseket a kódban, győződjön meg arról, hogy ismeri az alkalmazásfolyamat által használt kilépési kód konvenciót. Vegye figyelembe, hogy a kilépési kódot a számítási csomópont operációs rendszere is létrehozhatja, például amikor egy folyamat kényszerített módon leáll.

failureInfo

TaskFailureInformation

A feladathibát leíró információk, ha vannak ilyenek.
Ez a tulajdonság csak akkor van beállítva, ha a tevékenység befejezett állapotban van, és hibát észlelt.

result

TaskExecutionResult

A feladat végrehajtásának eredménye.
Ha az érték "failed", akkor a hiba részletei megtalálhatók a failureInfo tulajdonságban.

startTime

string

A tevékenység futásának időpontja.
Ha a tevékenység újraindult vagy újrapróbálkozott, akkor ez a legutóbbi időpont, amikor a tevékenység elindult.

state

JobReleaseTaskState

A számítási csomópont feladatkiadási tevékenységének aktuális állapota.

taskRootDirectory

string

A számítási csomópont feladatkiadási feladatának gyökérkönyvtára. Ezzel az elérési úttal lekérheti a tevékenység által létrehozott fájlokat, például naplófájlokat.

taskRootDirectoryUrl

string

A számítási csomópont feladatkiadási feladatának gyökérkönyvtárának URL-címe.

JobReleaseTaskState

A számítási csomópont feladatkiadási tevékenységének aktuális állapota.

Name Típus Description
completed

string

A tevékenység a 0-s kilépési kóddal lépett ki, vagy a tevékenység kimerítette az újrapróbálkozási korlátot, vagy a Batch szolgáltatás nem tudta elindítani a feladatot a tevékenység előkészítésével kapcsolatos hibák (például az erőforrásfájl letöltési hibái) miatt.

running

string

A feladat jelenleg fut (beleértve az újrapróbálkozást is).

NameValuePair

Név-érték párokat jelöl.

Name Típus Description
name

string

A név-érték párban lévő név.

value

string

A név-érték párban lévő érték.

TaskContainerExecutionInformation

Információkat tartalmaz arról a tárolóról, amelyet egy feladat hajt végre.

Name Típus Description
containerId

string

A tároló azonosítója.

error

string

A tárolóval kapcsolatos részletes hibainformációk.
Ez a Docker szolgáltatás részletes hibasztringje, ha elérhető. Ez egyenértékű a "docker-vizsgálat" által visszaadott hibamezővel.

state

string

A tároló állapota.
Ez a tároló állapota a Docker szolgáltatás szerint. Ez egyenértékű a "docker-vizsgálat" által visszaadott állapotmezővel.

TaskExecutionResult

A feladat végrehajtásának eredménye.

Name Típus Description
failure

string

Hiba történt a feladat feldolgozása során. Előfordulhat, hogy a hiba a Tevékenység folyamat elindítása előtt, a Tevékenység folyamat végrehajtásakor vagy a Tevékenység folyamat kilépése után következett be.

success

string

A feladat sikeresen lefutott.

TaskFailureInformation

A feladathibával kapcsolatos információk.

Name Típus Description
category

ErrorCategory

A Tevékenység hiba kategóriája.

code

string

A Tevékenység hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.

details

NameValuePair[]

A hibával kapcsolatos további részletek listája.

message

string

A feladathibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.