Job - List Preparation And Release Task Status

Referentie

Service:: Batch Service

API Version:: 2023-11-01.18.0

Geeft de uitvoeringsstatus weer van de taakvoorbereiding en taakrelease voor de opgegeven taak op de rekenknooppunten waarop de taak is uitgevoerd.
Deze API retourneert de taakvoorbereidings- en taakreleasestatus op alle rekenknooppunten waarop de taak Jobvoorbereiding of Taakrelease is uitgevoerd. Dit geldt ook voor rekenknooppunten die sindsdien uit de pool zijn verwijderd. Als deze API wordt aangeroepen voor een taak die geen taakvoorbereiding of taakreleasetaak heeft, retourneert de Batch-service HTTP-statuscode 409 (Conflict) met de foutcode 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-parameters

Name	In	Vereist	Type	Description
batchUrl	path	True	string	De basis-URL voor alle Azure Batch serviceaanvragen.
jobId	path	True	string	De id van de taak.
api-version	query	True	string	Client-API-versie.
$filter	query		string	Een OData $filter component. Zie voor meer informatie over het maken van dit filter https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status.
$select	query		string	Een OData-$select-component.
maxresults	query		integer int32	Het maximum aantal items dat in het antwoord moet worden geretourneerd. Er kunnen maximaal 1000 taken worden geretourneerd.
timeout	query		integer int32	De maximale tijd die de server kan besteden aan het verwerken van de aanvraag, in seconden. De standaardwaarde is 30 seconden.

Aanvraagkoptekst

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

Name	Type	Description
client-request-id	string uuid	De door de aanroeper gegenereerde aanvraagidentiteit, in de vorm van een GUID zonder decoratie, zoals accolades, bijvoorbeeld 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Of de server de client-request-id in het antwoord moet retourneren.
ocp-date	string date-time-rfc1123	Het tijdstip waarop de aanvraag is uitgegeven. Clientbibliotheken stellen dit doorgaans in op de huidige systeemkloktijd; stel deze expliciet in als u de REST API rechtstreeks aanroept.

Antwoorden

Name	Type	Description
200 OK	CloudJobListPreparationAndReleaseTaskStatusResult	Een antwoord met een lijst met statussen jobvoorbereiding en taakrelease. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	De fout van de Batch-service. Als deze API wordt aangeroepen voor een taak die geen taakvoorbereiding of taakreleasetaak heeft, retourneert de Batch-service HTTP-statuscode 409.

Name

Type

Description

200 OK

CloudJobListPreparationAndReleaseTaskStatusResult

Een antwoord met een lijst met statussen jobvoorbereiding en taakrelease.

Headers

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

Other Status Codes

BatchError

De fout van de Batch-service. Als deze API wordt aangeroepen voor een taak die geen taakvoorbereiding of taakreleasetaak heeft, retourneert de Batch-service HTTP-statuscode 409.

Beveiliging

azure_auth

Microsoft Entra OAuth 2.0-verificatiecodestroom

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

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Authorization

Type: apiKey
In: header

Voorbeelden

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

Definities

Name	Description
BatchError	Een foutbericht ontvangen van de Azure Batch-service.
BatchErrorDetail	Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.
CloudJobListPreparationAndReleaseTaskStatusResult	Het resultaat van het weergeven van de status van de taakvoorbereidings- en taakreleasetaken voor een taak.
ErrorCategory	De categorie van de fout.
ErrorMessage	Een foutbericht ontvangen in een Azure Batch foutbericht.
JobPreparationAndReleaseTaskExecutionInformation	De status van de taakvoorbereidings- en taakreleasetaken op een rekenknooppunt.
JobPreparationTaskExecutionInformation	Bevat informatie over de uitvoering van een taakvoorbereidingstaak op een rekenknooppunt.
JobPreparationTaskState	De huidige status van de taakvoorbereidingstaak op het rekenknooppunt.
JobReleaseTaskExecutionInformation	Bevat informatie over de uitvoering van een taakreleasetaak op een rekenknooppunt.
JobReleaseTaskState	De huidige status van de taakreleasetaak op het rekenknooppunt.
NameValuePair	Vertegenwoordigt een naam-waardepaar.
TaskContainerExecutionInformation	Bevat informatie over de container die door een taak wordt uitgevoerd.
TaskExecutionResult	Het resultaat van taakuitvoering.
TaskFailureInformation	Informatie over een taakfout.

BatchError

Een foutbericht ontvangen van de Azure Batch-service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
message	ErrorMessage	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
values	BatchErrorDetail[]	Een verzameling sleutel-waardeparen met aanvullende informatie over de fout.

BatchErrorDetail

Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.

Name	Type	Description
key	string	Een id die de betekenis van de eigenschap Value aangeeft.
value	string	De aanvullende informatie die is opgenomen in de foutreactie.

CloudJobListPreparationAndReleaseTaskStatusResult

Het resultaat van het weergeven van de status van de taakvoorbereidings- en taakreleasetaken voor een taak.

Name	Type	Description
odata.nextLink	string	De URL voor het ophalen van de volgende set resultaten.
value	JobPreparationAndReleaseTaskExecutionInformation[]	Een lijst met informatie over taakvoorbereiding en taakuitgifte.

ErrorCategory

De categorie van de fout.

Name	Type	Description
servererror	string	De fout wordt veroorzaakt door een intern serverprobleem.
usererror	string	De fout wordt veroorzaakt door een gebruikersprobleem, zoals een onjuiste configuratie.

ErrorMessage

Een foutbericht ontvangen in een Azure Batch foutbericht.

Name	Type	Description
lang	string	De taalcode van het foutbericht
value	string	De tekst van het bericht.

JobPreparationAndReleaseTaskExecutionInformation

De status van de taakvoorbereidings- en taakreleasetaken op een rekenknooppunt.

Name	Type	Description
jobPreparationTaskExecutionInfo	JobPreparationTaskExecutionInformation	Informatie over de uitvoeringsstatus van de taakvoorbereidingstaak op dit rekenknooppunt.
jobReleaseTaskExecutionInfo	JobReleaseTaskExecutionInformation	Informatie over de uitvoeringsstatus van de taakreleasetaak op dit rekenknooppunt. Deze eigenschap wordt alleen ingesteld als de taak releasetaak is uitgevoerd op het rekenknooppunt.
nodeId	string	De id van het rekenknooppunt waarnaar deze vermelding verwijst.
nodeUrl	string	De URL van het rekenknooppunt waarnaar deze vermelding verwijst.
poolId	string	De id van de pool die het rekenknooppunt bevat waarnaar deze vermelding verwijst.

JobPreparationTaskExecutionInformation

Bevat informatie over de uitvoering van een taakvoorbereidingstaak op een rekenknooppunt.

Name	Type	Description
containerInfo	TaskContainerExecutionInformation	Informatie over de container waaronder de taak wordt uitgevoerd. Deze eigenschap wordt alleen ingesteld als de taak wordt uitgevoerd in een containercontext.
endTime	string	Het tijdstip waarop de taakvoorbereidingstaak is voltooid. Deze eigenschap wordt alleen ingesteld als de taak de status Voltooid heeft.
exitCode	integer	De afsluitcode van het programma dat is opgegeven op de taakopdrachtregel. Deze parameter wordt alleen geretourneerd als de taak de status Voltooid heeft. De afsluitcode voor een proces weerspiegelt de specifieke conventie die is geïmplementeerd door de ontwikkelaar van de toepassing voor dat proces. Als u de waarde van de afsluitcode gebruikt om beslissingen te nemen in uw code, moet u ervoor zorgen dat u de afsluitcodeconventie kent die door het toepassingsproces wordt gebruikt. Houd er rekening mee dat de afsluitcode ook kan worden gegenereerd door het besturingssysteem Rekenknooppunt, bijvoorbeeld wanneer een proces geforceerd wordt beëindigd.
failureInfo	TaskFailureInformation	Informatie over de taakfout, indien aanwezig. Deze eigenschap wordt alleen ingesteld als de taak de status Voltooid heeft en er een fout is opgetreden.
lastRetryTime	string	Het meest recente tijdstip waarop een nieuwe poging van de taakvoorbereidingstaak is gestart. Deze eigenschap wordt alleen ingesteld als de taak opnieuw is geprobeerd (retryCount is een andere dan nul). Indien aanwezig, is dit meestal hetzelfde als startTime, maar kan anders zijn als de taak opnieuw is gestart om andere redenen dan opnieuw proberen. Als het rekenknooppunt bijvoorbeeld opnieuw is opgestart tijdens een nieuwe poging, wordt de startTime bijgewerkt, maar de lastRetryTime niet.
result	TaskExecutionResult	Het resultaat van de taakuitvoering. Als de waarde 'mislukt' is, kunt u de details van de fout vinden in de eigenschap failureInfo.
retryCount	integer	Het aantal keren dat de taak opnieuw is geprobeerd door de Batch-service. Fouten in de taaktoepassing (niet-nul afsluitcode) worden opnieuw geprobeerd, voorverwerkingsfouten (de taak kan niet worden uitgevoerd) en fouten bij het uploaden van bestanden worden niet opnieuw geprobeerd. De Batch-service voert de taak opnieuw uit tot de limiet die is opgegeven door de beperkingen. Fouten in de taaktoepassing (niet-nul afsluitcode) worden opnieuw geprobeerd, voorverwerkingsfouten (de taak kan niet worden uitgevoerd) en fouten bij het uploaden van bestanden worden niet opnieuw geprobeerd. De Batch-service voert de taak opnieuw uit tot de limiet die is opgegeven door de beperkingen.
startTime	string	Het tijdstip waarop de taak is gestart. Als de taak opnieuw is gestart of opnieuw is geprobeerd, is dit het meest recente tijdstip waarop de taak is gestart.
state	JobPreparationTaskState	De huidige status van de taakvoorbereidingstaak op het rekenknooppunt.
taskRootDirectory	string	De hoofdmap van de taakvoorbereidingstaak op het rekenknooppunt. U kunt dit pad gebruiken om bestanden op te halen die door de taak zijn gemaakt, zoals logboekbestanden.
taskRootDirectoryUrl	string	De URL naar de hoofdmap van de taakvoorbereidingstaak op het rekenknooppunt.

JobPreparationTaskState

De huidige status van de taakvoorbereidingstaak op het rekenknooppunt.

Name	Type	Description
completed	string	De taak is afgesloten met afsluitcode 0, of de taak heeft de limiet voor opnieuw proberen bereikt of de Batch-service kan de taak niet starten vanwege taakvoorbereidingsfouten (zoals fouten bij het downloaden van resourcebestanden).
running	string	De taak wordt momenteel uitgevoerd (inclusief opnieuw proberen).

JobReleaseTaskExecutionInformation

Bevat informatie over de uitvoering van een taakreleasetaak op een rekenknooppunt.

Name	Type	Description
containerInfo	TaskContainerExecutionInformation	Informatie over de container waaronder de taak wordt uitgevoerd. Deze eigenschap wordt alleen ingesteld als de taak wordt uitgevoerd in een containercontext.
endTime	string	Het tijdstip waarop de taak voor het vrijgeven van de taak is voltooid. Deze eigenschap wordt alleen ingesteld als de taak de status Voltooid heeft.
exitCode	integer	De afsluitcode van het programma dat is opgegeven op de taakopdrachtregel. Deze parameter wordt alleen geretourneerd als de taak de status Voltooid heeft. De afsluitcode voor een proces weerspiegelt de specifieke conventie die is geïmplementeerd door de ontwikkelaar van de toepassing voor dat proces. Als u de waarde van de afsluitcode gebruikt om beslissingen te nemen in uw code, moet u ervoor zorgen dat u de afsluitcodeconventie kent die door het toepassingsproces wordt gebruikt. Houd er rekening mee dat de afsluitcode ook kan worden gegenereerd door het besturingssysteem Rekenknooppunt, bijvoorbeeld wanneer een proces geforceerd wordt beëindigd.
failureInfo	TaskFailureInformation	Informatie over de taakfout, indien aanwezig. Deze eigenschap wordt alleen ingesteld als de taak de status Voltooid heeft en er een fout is opgetreden.
result	TaskExecutionResult	Het resultaat van de taakuitvoering. Als de waarde 'mislukt' is, kunt u de details van de fout vinden in de eigenschap failureInfo.
startTime	string	Het tijdstip waarop de taak is gestart. Als de taak opnieuw is gestart of opnieuw is geprobeerd, is dit het meest recente tijdstip waarop de taak is gestart.
state	JobReleaseTaskState	De huidige status van de taakreleasetaak op het rekenknooppunt.
taskRootDirectory	string	De hoofdmap van de taakreleasetaak op het rekenknooppunt. U kunt dit pad gebruiken om bestanden op te halen die door de taak zijn gemaakt, zoals logboekbestanden.
taskRootDirectoryUrl	string	De URL naar de hoofdmap van de taakreleasetaak op het rekenknooppunt.

JobReleaseTaskState

De huidige status van de taakreleasetaak op het rekenknooppunt.

Name	Type	Description
completed	string	De taak is afgesloten met afsluitcode 0, of de taak heeft de limiet voor opnieuw proberen bereikt of de Batch-service kan de taak niet starten vanwege taakvoorbereidingsfouten (zoals fouten bij het downloaden van resourcebestanden).
running	string	De taak wordt momenteel uitgevoerd (inclusief opnieuw proberen).

NameValuePair

Vertegenwoordigt een naam-waardepaar.

Name	Type	Description
name	string	De naam in het naam-waardepaar.
value	string	De waarde in het naam-waardepaar.

TaskContainerExecutionInformation

Bevat informatie over de container die door een taak wordt uitgevoerd.

Name	Type	Description
containerId	string	De id van de container.
error	string	Gedetailleerde foutinformatie over de container. Dit is de gedetailleerde foutreeks van de Docker-service, indien beschikbaar. Dit is gelijk aan het foutveld dat wordt geretourneerd door 'docker inspect'.
state	string	De status van de container. Dit is de status van de container volgens de Docker-service. Het is gelijk aan het statusveld dat wordt geretourneerd door 'docker inspect'.

TaskExecutionResult

Het resultaat van taakuitvoering.

Name	Type	Description
failure	string	Er is een fout opgetreden tijdens het verwerken van de taak. De fout is mogelijk opgetreden voordat het taakproces werd gestart, terwijl het taakproces werd uitgevoerd of nadat het taakproces werd afgesloten.
success	string	De taak is uitgevoerd.

TaskFailureInformation

Informatie over een taakfout.

Name	Type	Description
category	ErrorCategory	De categorie van de taakfout.
code	string	Een id voor de taakfout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details	NameValuePair[]	Een lijst met aanvullende details met betrekking tot de fout.
message	string	Een bericht met een beschrijving van de taakfout, bedoeld om te worden weergegeven in een gebruikersinterface.

Job - List Preparation And Release Task Status

URI-parameters

Aanvraagkoptekst

Antwoorden

Beveiliging

azure_auth

Scopes

Authorization

Voorbeelden

Job list preparation and release task status

Sample Request

Sample Response

Definities

BatchError

BatchErrorDetail

CloudJobListPreparationAndReleaseTaskStatusResult

ErrorCategory

ErrorMessage

JobPreparationAndReleaseTaskExecutionInformation

JobPreparationTaskExecutionInformation

JobPreparationTaskState

JobReleaseTaskExecutionInformation

JobReleaseTaskState

NameValuePair

TaskContainerExecutionInformation

TaskExecutionResult

TaskFailureInformation

Aanvullende resources