Job - List Preparation And Release Task Status

Referens

Service:: Batch Service

API Version:: 2023-11-01.18.0

Visar körningsstatus för jobbförberedelse- och jobbpubliceringsaktiviteten för det angivna jobbet över beräkningsnoderna där jobbet har körts.
Det här API:et returnerar statusen Jobbförberedelse och Jobbpubliceringsaktivitet på alla beräkningsnoder som har kört jobbförberedelse- eller jobbpubliceringsaktiviteten. Detta inkluderar beräkningsnoder som sedan dess har tagits bort från poolen. Om det här API:et anropas för ett jobb som inte har någon jobbförberedelse eller jobbpubliceringsaktivitet returnerar Batch-tjänsten HTTP-statuskod 409 (konflikt) med felkoden 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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
batchUrl	path	True	string	Bas-URL:en för alla Azure Batch tjänstbegäranden.
jobId	path	True	string	Jobbets ID.
api-version	query	True	string	Klient-API-version.
$filter	query		string	En OData-$filter-sats. Mer information om hur du skapar det här filtret finns i https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status.
$select	query		string	En OData-$select-sats.
maxresults	query		integer int32	Det maximala antalet objekt som ska returneras i svaret. Högst 1 000 aktiviteter kan returneras.
timeout	query		integer int32	Den maximala tid som servern kan ägna åt att bearbeta begäran, i sekunder. Standardvärdet är 30 sekunder.

Begärandehuvud

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

Name	Typ	Description
client-request-id	string uuid	Den anropargenererade begärandeidentiteten i form av ett GUID utan dekoration, till exempel klammerparenteser, t.ex. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Om servern ska returnera client-request-id i svaret.
ocp-date	string date-time-rfc1123	Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till systemets aktuella klocktid. ange det uttryckligen om du anropar REST-API:et direkt.

Svar

Name	Typ	Description
200 OK	CloudJobListPreparationAndReleaseTaskStatusResult	Ett svar som innehåller en lista över status för jobbförberedelser och jobbpubliceringsaktivitet. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Felet från Batch-tjänsten. Om det här API:et anropas för ett jobb som inte har någon jobbförberedelse eller jobbpubliceringsaktivitet returnerar Batch-tjänsten HTTP-statuskod 409.

Name

Typ

Description

200 OK

CloudJobListPreparationAndReleaseTaskStatusResult

Ett svar som innehåller en lista över status för jobbförberedelser och jobbpubliceringsaktivitet.

Headers

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

Other Status Codes

BatchError

Felet från Batch-tjänsten. Om det här API:et anropas för ett jobb som inte har någon jobbförberedelse eller jobbpubliceringsaktivitet returnerar Batch-tjänsten HTTP-statuskod 409.

Säkerhet

azure_auth

Microsoft Entra OAuth 2.0-autentiseringskodflöde

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

Scopes

Name	Description
user_impersonation	Personifiera ditt användarkonto

Authorization

Type: apiKey
In: header

Exempel

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

Definitioner

Name	Description
BatchError	Ett felsvar som tagits emot från Azure Batch-tjänsten.
BatchErrorDetail	Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar.
CloudJobListPreparationAndReleaseTaskStatusResult	Resultatet av att visa status för jobbförberedelse- och jobbpubliceringsaktiviteterna för ett jobb.
ErrorCategory	Kategorin för felet.
ErrorMessage	Ett felmeddelande som tas emot i ett Azure Batch felsvar.
JobPreparationAndReleaseTaskExecutionInformation	Status för jobbförberedelse- och jobbpubliceringsaktiviteterna på en beräkningsnod.
JobPreparationTaskExecutionInformation	Innehåller information om körningen av en jobbförberedelseaktivitet på en beräkningsnod.
JobPreparationTaskState	Det aktuella tillståndet för jobbförberedelseaktiviteten på beräkningsnoden.
JobReleaseTaskExecutionInformation	Innehåller information om körningen av en jobbpubliceringsaktivitet på en beräkningsnod.
JobReleaseTaskState	Det aktuella tillståndet för jobbpubliceringsaktiviteten på beräkningsnoden.
NameValuePair	Representerar ett namn/värde-par.
TaskContainerExecutionInformation	Innehåller information om containern som en aktivitet körs i.
TaskExecutionResult	Resultatet av aktivitetskörningen.
TaskFailureInformation	Information om ett aktivitetsfel.

BatchError

Ett felsvar som tagits emot från Azure Batch-tjänsten.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
message	ErrorMessage	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
values	BatchErrorDetail[]	En samling nyckel/värde-par som innehåller ytterligare information om felet.

BatchErrorDetail

Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar.

Name	Typ	Description
key	string	En identifierare som anger innebörden av egenskapen Value.
value	string	Den ytterligare information som ingår i felsvaret.

CloudJobListPreparationAndReleaseTaskStatusResult

Resultatet av att visa status för jobbförberedelse- och jobbpubliceringsaktiviteterna för ett jobb.

Name	Typ	Description
odata.nextLink	string	URL:en för att hämta nästa uppsättning resultat.
value	JobPreparationAndReleaseTaskExecutionInformation[]	En lista över körningsinformation för jobbförberedelse och jobbpublicering.

ErrorCategory

Kategorin för felet.

Name	Typ	Description
servererror	string	Felet beror på ett internt serverproblem.
usererror	string	Felet beror på ett användarproblem, till exempel felkonfiguration.

ErrorMessage

Ett felmeddelande som tas emot i ett Azure Batch felsvar.

Name	Typ	Description
lang	string	Språkkoden för felmeddelandet
value	string	Texten i meddelandet.

JobPreparationAndReleaseTaskExecutionInformation

Status för jobbförberedelse- och jobbpubliceringsaktiviteterna på en beräkningsnod.

Name	Typ	Description
jobPreparationTaskExecutionInfo	JobPreparationTaskExecutionInformation	Information om körningsstatus för jobbförberedelseaktiviteten på den här beräkningsnoden.
jobReleaseTaskExecutionInfo	JobReleaseTaskExecutionInformation	Information om körningsstatus för jobbpubliceringsaktiviteten på den här beräkningsnoden. Den här egenskapen anges endast om jobbpubliceringsaktiviteten har körts på beräkningsnoden.
nodeId	string	ID:t för beräkningsnoden som den här posten refererar till.
nodeUrl	string	URL:en för beräkningsnoden som den här posten refererar till.
poolId	string	ID:t för poolen som innehåller beräkningsnoden som den här posten refererar till.

JobPreparationTaskExecutionInformation

Innehåller information om körningen av en jobbförberedelseaktivitet på en beräkningsnod.

Name	Typ	Description
containerInfo	TaskContainerExecutionInformation	Information om containern under vilken aktiviteten körs. Den här egenskapen anges endast om aktiviteten körs i en containerkontext.
endTime	string	Tidpunkten då jobbförberedelseaktiviteten slutfördes. Den här egenskapen anges endast om aktiviteten är i tillståndet Slutförd.
exitCode	integer	Slutkoden för programmet som anges på kommandoraden Aktivitet. Den här parametern returneras endast om aktiviteten är i slutfört tillstånd. Slutkoden för en process återspeglar den specifika konvention som implementerats av programutvecklaren för den processen. Om du använder slutkodsvärdet för att fatta beslut i koden ska du vara säker på att du känner till den slutkodskonvention som används av programprocessen. Observera att slutkoden också kan genereras av operativsystemet Compute Node, till exempel när en process avslutas med två skäl.
failureInfo	TaskFailureInformation	Information som beskriver eventuella aktivitetsfel. Den här egenskapen anges endast om aktiviteten är i slutfört tillstånd och påträffade ett fel.
lastRetryTime	string	Den senaste tiden då ett nytt försök av jobbförberedelseaktiviteten började köras. Den här egenskapen anges endast om aktiviteten gjordes om (dvs. retryCount är inte noll). Om det finns är detta vanligtvis samma som startTime, men kan skilja sig om aktiviteten har startats om av andra orsaker än att försöka igen. Om beräkningsnoden till exempel startades om under ett nytt försök uppdateras startTime men inte lastRetryTime.
result	TaskExecutionResult	Resultatet av aktivitetskörningen. Om värdet är "failed" (misslyckades) finns information om felet i egenskapen failureInfo.
retryCount	integer	Antalet gånger som Batch-tjänsten har försökt utföra uppgiften igen. Fel i aktivitetsprogram (slutkod som inte är noll) görs om, förbearbetningsfel (aktiviteten kunde inte köras) och filuppladdningsfel görs inte på nytt. Batch-tjänsten försöker utföra uppgiften igen upp till den gräns som anges av begränsningarna. Fel i aktivitetsprogram (slutkod som inte är noll) görs om, förbearbetningsfel (aktiviteten kunde inte köras) och filuppladdningsfel görs inte på nytt. Batch-tjänsten försöker utföra uppgiften igen upp till den gräns som anges av begränsningarna.
startTime	string	Tidpunkten då aktiviteten började köras. Om aktiviteten har startats om eller gjorts om är det här den senaste gången som aktiviteten började köras.
state	JobPreparationTaskState	Det aktuella tillståndet för jobbförberedelseaktiviteten på beräkningsnoden.
taskRootDirectory	string	Rotkatalogen för jobbförberedelseaktiviteten på beräkningsnoden. Du kan använda den här sökvägen för att hämta filer som skapats av aktiviteten, till exempel loggfiler.
taskRootDirectoryUrl	string	URL:en till rotkatalogen för jobbförberedelseaktiviteten på beräkningsnoden.

JobPreparationTaskState

Det aktuella tillståndet för jobbförberedelseaktiviteten på beräkningsnoden.

Name	Typ	Description
completed	string	Aktiviteten har avslutats med slutkod 0, eller så har aktiviteten överskridit gränsen för återförsök, eller så kunde Batch-tjänsten inte starta aktiviteten på grund av aktivitetsförberedelsefel (till exempel fel vid nedladdning av resursfiler).
running	string	Aktiviteten körs för närvarande (inklusive återförsök).

JobReleaseTaskExecutionInformation

Innehåller information om körningen av en jobbpubliceringsaktivitet på en beräkningsnod.

Name	Typ	Description
containerInfo	TaskContainerExecutionInformation	Information om containern under vilken aktiviteten körs. Den här egenskapen anges endast om aktiviteten körs i en containerkontext.
endTime	string	Tidpunkten då jobbpubliceringsaktiviteten slutfördes. Den här egenskapen anges endast om aktiviteten är i tillståndet Slutförd.
exitCode	integer	Slutkoden för programmet som anges på kommandoraden Aktivitet. Den här parametern returneras endast om aktiviteten är i slutfört tillstånd. Slutkoden för en process återspeglar den specifika konvention som implementerats av programutvecklaren för den processen. Om du använder slutkodsvärdet för att fatta beslut i koden ska du vara säker på att du känner till den slutkodskonvention som används av programprocessen. Observera att slutkoden också kan genereras av operativsystemet Compute Node, till exempel när en process avslutas med två skäl.
failureInfo	TaskFailureInformation	Information som beskriver eventuella aktivitetsfel. Den här egenskapen anges endast om aktiviteten är i slutfört tillstånd och påträffade ett fel.
result	TaskExecutionResult	Resultatet av aktivitetskörningen. Om värdet är "failed" (misslyckades) finns information om felet i egenskapen failureInfo.
startTime	string	Tidpunkten då aktiviteten började köras. Om aktiviteten har startats om eller gjorts om är det här den senaste gången som aktiviteten började köras.
state	JobReleaseTaskState	Det aktuella tillståndet för jobbpubliceringsaktiviteten på beräkningsnoden.
taskRootDirectory	string	Rotkatalogen för jobbpubliceringsaktiviteten på beräkningsnoden. Du kan använda den här sökvägen för att hämta filer som skapats av aktiviteten, till exempel loggfiler.
taskRootDirectoryUrl	string	URL:en till rotkatalogen för jobbpubliceringsaktiviteten på beräkningsnoden.

JobReleaseTaskState

Det aktuella tillståndet för jobbpubliceringsaktiviteten på beräkningsnoden.

Name	Typ	Description
completed	string	Aktiviteten har avslutats med slutkod 0, eller så har aktiviteten överskridit gränsen för återförsök, eller så kunde Batch-tjänsten inte starta aktiviteten på grund av aktivitetsförberedelsefel (till exempel fel vid nedladdning av resursfiler).
running	string	Aktiviteten körs för närvarande (inklusive återförsök).

NameValuePair

Representerar ett namn/värde-par.

Name	Typ	Description
name	string	Namnet i namn/värde-paret.
value	string	Värdet i namn/värde-paret.

TaskContainerExecutionInformation

Innehåller information om containern som en aktivitet körs i.

Name	Typ	Description
containerId	string	Containerns ID.
error	string	Detaljerad felinformation om containern. Det här är den detaljerade felsträngen från Docker-tjänsten, om den är tillgänglig. Det motsvarar det felfält som returneras av "docker inspect".
state	string	Containerns tillstånd. Det här är containerns tillstånd enligt Docker-tjänsten. Det motsvarar statusfältet som returneras av "docker inspect".

TaskExecutionResult

Resultatet av aktivitetskörningen.

Name	Typ	Description
failure	string	Ett fel uppstod under bearbetningen av aktiviteten. Felet kan ha inträffat innan aktivitetsprocessen startades, medan aktivitetsprocessen kördes eller efter att uppgiftsprocessen avslutades.
success	string	Uppgiften har körts.

TaskFailureInformation

Information om ett aktivitetsfel.

Name	Typ	Description
category	ErrorCategory	Kategorin för aktivitetsfelet.
code	string	En identifierare för aktivitetsfelet. Koder är invarianta och är avsedda att användas programmatiskt.
details	NameValuePair[]	En lista med ytterligare information som rör felet.
message	string	Ett meddelande som beskriver aktivitetsfelet, avsett att vara lämpligt för visning i ett användargränssnitt.

Share via

Job - List Preparation And Release Task Status

URI-parametrar

Begärandehuvud

Svar

Säkerhet

azure_auth

Scopes

Authorization

Exempel

Job list preparation and release task status

Sample Request

Sample Response

Definitioner

BatchError

BatchErrorDetail

CloudJobListPreparationAndReleaseTaskStatusResult

ErrorCategory

ErrorMessage

JobPreparationAndReleaseTaskExecutionInformation

JobPreparationTaskExecutionInformation

JobPreparationTaskState

JobReleaseTaskExecutionInformation

JobReleaseTaskState

NameValuePair

TaskContainerExecutionInformation

TaskExecutionResult

TaskFailureInformation

Ytterligare resurser