Job - List Preparation And Release Task Status

Référence

Service:: Batch Service

Version d'API:: 2024-07-01.20.0

Répertorie l’état d’exécution de la tâche de préparation et de mise en production du travail pour le travail spécifié sur les nœuds de calcul où le travail est exécuté.
Cette API retourne l’état de la tâche de préparation du travail et de mise en production du travail sur tous les nœuds de calcul qui ont exécuté la tâche de préparation du travail ou de mise en production du travail. Cela inclut les nœuds de calcul qui ont été supprimés du pool. Si cette API est appelée sur un travail qui n’a aucune tâche de préparation du travail ou de publication de travaux, le service Batch retourne le code d’état HTTP 409 (Conflit) avec un code d’erreur jobPreparationTaskNotSpecified.

GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?api-version=2024-07-01.20.0

Avec des paramètres facultatifs:

GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
batchUrl	path	True	string	URL de base pour toutes les demandes de service Azure Batch.
jobId	path	True	string	ID du travail.
api-version	query	True	string	Version de l’API cliente.
$filter	query		string	Clause OData $filter. Pour plus d’informations sur la construction de ce filtre, consultez https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status.
$select	query		string	Clause OData $select.
maxresults	query		integer int32	Nombre maximal d’éléments à retourner dans la réponse. Un maximum de 1 000 tâches peut être retourné.
timeout	query		integer int32	Durée maximale pendant laquelle le serveur peut passer le traitement de la requête, en secondes. La valeur par défaut est de 30 secondes. Si la valeur est supérieure à 30, la valeur par défaut est utilisée à la place.

En-tête de la demande

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

Nom	Type	Description
client-request-id	string uuid	L’identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration telle que les accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Indique si le serveur doit retourner l’ID client-request-id dans la réponse.
ocp-date	string date-time-rfc1123	Heure à laquelle la demande a été émise. Les bibliothèques clientes définissent généralement cette valeur sur l’heure de l’horloge système actuelle ; définissez-le explicitement si vous appelez directement l’API REST.

Réponses

Nom	Type	Description
200 OK	CloudJobListPreparationAndReleaseTaskStatusResult	Réponse contenant la liste des états de la tâche de préparation et de mise en production du travail. En-têtes client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Erreur du service Batch. Si cette API est appelée sur un travail qui n’a aucune tâche de préparation du travail ou de publication de travaux, le service Batch retourne le code d’état HTTP 409.

Nom

Type

Description

200 OK

CloudJobListPreparationAndReleaseTaskStatusResult

Réponse contenant la liste des états de la tâche de préparation et de mise en production du travail.

En-têtes

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

Other Status Codes

BatchError

Erreur du service Batch. Si cette API est appelée sur un travail qui n’a aucune tâche de préparation du travail ou de publication de travaux, le service Batch retourne le code d’état HTTP 409.

Sécurité

azure_auth

Flux de code d’authentification Microsoft Entra OAuth 2.0

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Authorization

Type: apiKey
Dans: header

Exemples

Job list preparation and release task status

Exemple de requête

HTTP

GET account.region.batch.azure.com/jobs/jobId/jobpreparationandreleasetaskstatus?api-version=2024-07-01.20.0

Exemple de réponse

Code d’état:: 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=2024-07-01.20.0"
}

Définitions

Nom	Description
BatchError	Réponse d’erreur reçue du service Azure Batch.
BatchErrorDetail	Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch.
CloudJobListPreparationAndReleaseTaskStatusResult	Résultat de la liste de l’état des tâches de préparation et de publication du travail pour un travail.
ErrorCategory	Catégorie de l’erreur.
ErrorMessage	Message d’erreur reçu dans une réponse d’erreur Azure Batch.
JobPreparationAndReleaseTaskExecutionInformation	État des tâches de préparation et de mise en production du travail sur un nœud de calcul.
JobPreparationTaskExecutionInformation	Contient des informations sur l’exécution d’une tâche de préparation du travail sur un nœud de calcul.
JobPreparationTaskState	État actuel de la tâche de préparation du travail sur le nœud de calcul.
JobReleaseTaskExecutionInformation	Contient des informations sur l’exécution d’une tâche de publication de travail sur un nœud de calcul.
JobReleaseTaskState	État actuel de la tâche de mise en production du travail sur le nœud de calcul.
NameValuePair	Représente une paire nom-valeur.
TaskContainerExecutionInformation	Contient des informations sur le conteneur exécuté par une tâche.
TaskExecutionResult	Résultat de l’exécution de la tâche.
TaskFailureInformation	Informations sur un échec de tâche.

BatchError

Réponse d’erreur reçue du service Azure Batch.

Nom	Type	Description
code	string	Identificateur de l’erreur. Les codes sont invariants et sont destinés à être consommés par programme.
message	ErrorMessage	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
values	BatchErrorDetail[]	Collection de paires clé-valeur contenant des détails supplémentaires sur l’erreur.

BatchErrorDetail

Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch.

Nom	Type	Description
key	string	Identificateur spécifiant la signification de la propriété Value.
value	string	Informations supplémentaires incluses dans la réponse d’erreur.

CloudJobListPreparationAndReleaseTaskStatusResult

Résultat de la liste de l’état des tâches de préparation et de publication du travail pour un travail.

Nom	Type	Description
odata.nextLink	string	URL permettant d’obtenir le jeu de résultats suivant.
value	JobPreparationAndReleaseTaskExecutionInformation[]	Liste des informations d’exécution des tâches de préparation et de mise en production du travail.

ErrorCategory

Catégorie de l’erreur.

Nom	Type	Description
servererror	string	L’erreur est due à un problème de serveur interne.
usererror	string	L’erreur est due à un problème d’utilisateur, tel que la configuration incorrecte.

ErrorMessage

Message d’erreur reçu dans une réponse d’erreur Azure Batch.

Nom	Type	Description
lang	string	Code de langue du message d’erreur
value	string	Texte du message.

JobPreparationAndReleaseTaskExecutionInformation

État des tâches de préparation et de mise en production du travail sur un nœud de calcul.

Nom	Type	Description
jobPreparationTaskExecutionInfo	JobPreparationTaskExecutionInformation	Informations sur l’état d’exécution de la tâche de préparation du travail sur ce nœud de calcul.
jobReleaseTaskExecutionInfo	JobReleaseTaskExecutionInformation	Informations sur l’état d’exécution de la tâche de mise en production du travail sur ce nœud de calcul. Cette propriété est définie uniquement si la tâche de mise en production du travail s’est exécutée sur le nœud de calcul.
nodeId	string	ID du nœud de calcul auquel cette entrée fait référence.
nodeUrl	string	URL du nœud de calcul auquel cette entrée fait référence.
poolId	string	ID du pool contenant le nœud de calcul auquel cette entrée fait référence.

JobPreparationTaskExecutionInformation

Contient des informations sur l’exécution d’une tâche de préparation du travail sur un nœud de calcul.

Nom	Type	Description
containerInfo	TaskContainerExecutionInformation	Informations sur le conteneur sous lequel la tâche s’exécute. Cette propriété est définie uniquement si la tâche s’exécute dans un contexte de conteneur.
endTime	string	Heure à laquelle la tâche de préparation du travail s’est terminée. Cette propriété est définie uniquement si la tâche est dans l’état Terminé.
exitCode	integer	Code de sortie du programme spécifié sur la ligne de commande Tâche. Ce paramètre est retourné uniquement si la tâche est dans l’état terminé. Le code de sortie d’un processus reflète la convention spécifique implémentée par le développeur d’applications pour ce processus. Si vous utilisez la valeur du code de sortie pour prendre des décisions dans votre code, veillez à connaître la convention de code de sortie utilisée par le processus d’application. Notez que le code de sortie peut également être généré par le système d’exploitation Nœud de calcul, par exemple lorsqu’un processus est arrêté de force.
failureInfo	TaskFailureInformation	Informations décrivant l’échec de la tâche, le cas échéant. Cette propriété est définie uniquement si la tâche est dans l’état terminé et a rencontré un échec.
lastRetryTime	string	Heure la plus récente à laquelle une nouvelle tentative de la tâche de préparation du travail a commencé à s’exécuter. Cette propriété est définie uniquement si la tâche a été retentée (c’est-à-dire que retryCount n’est pas différente de zéro). Si elle est présente, elle est généralement identique à startTime, mais peut être différente si la tâche a été redémarrée pour des raisons autres que la nouvelle tentative ; par exemple, si le nœud de calcul a été redémarré lors d’une nouvelle tentative, le startTime est mis à jour, mais le dernierRetryTime n’est pas.
result	TaskExecutionResult	Résultat de l’exécution de la tâche. Si la valeur est « échec », les détails de l’échec sont trouvés dans la propriété failureInfo.
retryCount	integer	Nombre de fois où la tâche a été retentée par le service Batch. Les échecs d’application de tâche (code de sortie différent de zéro) sont retentés, les erreurs de prétraitement (la tâche n’a pas pu être exécutée) et les erreurs de chargement de fichier ne sont pas retentées. Le service Batch réessaye la tâche jusqu’à la limite spécifiée par les contraintes. Les échecs d’application de tâche (code de sortie différent de zéro) sont retentés, les erreurs de prétraitement (la tâche n’a pas pu être exécutée) et les erreurs de chargement de fichier ne sont pas retentées. Le service Batch réessaye la tâche jusqu’à la limite spécifiée par les contraintes.
startTime	string	Heure à laquelle la tâche a commencé à s’exécuter. Si la tâche a été redémarrée ou retentée, il s’agit de l’heure la plus récente à laquelle la tâche a commencé à s’exécuter.
state	JobPreparationTaskState	État actuel de la tâche de préparation du travail sur le nœud de calcul.
taskRootDirectory	string	Répertoire racine de la tâche de préparation du travail sur le nœud de calcul. Vous pouvez utiliser ce chemin d’accès pour récupérer les fichiers créés par la tâche, tels que les fichiers journaux.
taskRootDirectoryUrl	string	URL du répertoire racine de la tâche de préparation du travail sur le nœud de calcul.

JobPreparationTaskState

État actuel de la tâche de préparation du travail sur le nœud de calcul.

Nom	Type	Description
completed	string	La tâche s’est terminée avec le code de sortie 0, ou la tâche a épuisé sa limite de nouvelles tentatives, ou le service Batch n’a pas pu démarrer la tâche en raison d’erreurs de préparation des tâches (telles que les échecs de téléchargement de fichiers de ressources).
running	string	La tâche est en cours d’exécution (y compris la nouvelle tentative).

JobReleaseTaskExecutionInformation

Contient des informations sur l’exécution d’une tâche de publication de travail sur un nœud de calcul.

Nom	Type	Description
containerInfo	TaskContainerExecutionInformation	Informations sur le conteneur sous lequel la tâche s’exécute. Cette propriété est définie uniquement si la tâche s’exécute dans un contexte de conteneur.
endTime	string	Heure à laquelle la tâche de publication du travail s’est terminée. Cette propriété est définie uniquement si la tâche est dans l’état Terminé.
exitCode	integer	Code de sortie du programme spécifié sur la ligne de commande Tâche. Ce paramètre est retourné uniquement si la tâche est dans l’état terminé. Le code de sortie d’un processus reflète la convention spécifique implémentée par le développeur d’applications pour ce processus. Si vous utilisez la valeur du code de sortie pour prendre des décisions dans votre code, veillez à connaître la convention de code de sortie utilisée par le processus d’application. Notez que le code de sortie peut également être généré par le système d’exploitation Nœud de calcul, par exemple lorsqu’un processus est arrêté de force.
failureInfo	TaskFailureInformation	Informations décrivant l’échec de la tâche, le cas échéant. Cette propriété est définie uniquement si la tâche est dans l’état terminé et a rencontré un échec.
result	TaskExecutionResult	Résultat de l’exécution de la tâche. Si la valeur est « échec », les détails de l’échec sont trouvés dans la propriété failureInfo.
startTime	string	Heure à laquelle la tâche a commencé à s’exécuter. Si la tâche a été redémarrée ou retentée, il s’agit de l’heure la plus récente à laquelle la tâche a commencé à s’exécuter.
state	JobReleaseTaskState	État actuel de la tâche de mise en production du travail sur le nœud de calcul.
taskRootDirectory	string	Répertoire racine de la tâche de mise en production du travail sur le nœud de calcul. Vous pouvez utiliser ce chemin d’accès pour récupérer les fichiers créés par la tâche, tels que les fichiers journaux.
taskRootDirectoryUrl	string	URL du répertoire racine de la tâche de mise en production du travail sur le nœud de calcul.

JobReleaseTaskState

État actuel de la tâche de mise en production du travail sur le nœud de calcul.

Nom	Type	Description
completed	string	La tâche s’est terminée avec le code de sortie 0, ou la tâche a épuisé sa limite de nouvelles tentatives, ou le service Batch n’a pas pu démarrer la tâche en raison d’erreurs de préparation des tâches (telles que les échecs de téléchargement de fichiers de ressources).
running	string	La tâche est en cours d’exécution (y compris la nouvelle tentative).

NameValuePair

Représente une paire nom-valeur.

Nom	Type	Description
name	string	Nom de la paire nom-valeur.
value	string	Valeur de la paire nom-valeur.

TaskContainerExecutionInformation

Contient des informations sur le conteneur exécuté par une tâche.

Nom	Type	Description
containerId	string	ID du conteneur.
error	string	Informations d’erreur détaillées sur le conteneur. Il s’agit de la chaîne d’erreur détaillée du service Docker, le cas échéant. Il équivaut au champ d’erreur retourné par « docker inspect ».
state	string	État du conteneur. Il s’agit de l’état du conteneur en fonction du service Docker. Il équivaut au champ d’état retourné par « docker inspect ».

TaskExecutionResult

Résultat de l’exécution de la tâche.

Nom	Type	Description
failure	string	Une erreur s’est produite lors du traitement de la tâche. L’échec peut s’être produit avant le lancement du processus de tâche, pendant l’exécution du processus de tâche ou après la sortie du processus de tâche.
success	string	La tâche s’est exécutée avec succès.

TaskFailureInformation

Informations sur un échec de tâche.

Nom	Type	Description
category	ErrorCategory	Catégorie de l’erreur de tâche.
code	string	Identificateur de l’erreur de tâche. Les codes sont invariants et sont destinés à être consommés par programme.
details	NameValuePair[]	Liste des détails supplémentaires liés à l’erreur.
message	string	Message décrivant l’erreur de tâche, destiné à être adapté à l’affichage dans une interface utilisateur.

Partager via

Job - List Preparation And Release Task Status

Paramètres URI

En-tête de la demande

Réponses

Sécurité

azure_auth

Étendues

Authorization

Exemples

Job list preparation and release task status

Exemple de requête

Exemple de réponse

Définitions

BatchError

BatchErrorDetail

CloudJobListPreparationAndReleaseTaskStatusResult

ErrorCategory

ErrorMessage

JobPreparationAndReleaseTaskExecutionInformation

JobPreparationTaskExecutionInformation

JobPreparationTaskState

JobReleaseTaskExecutionInformation

JobReleaseTaskState

NameValuePair

TaskContainerExecutionInformation

TaskExecutionResult

TaskFailureInformation

Ressources supplémentaires