Job - List Preparation And Release Task Status
Répertorie les status 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 sur lesquels le travail s’est exécuté.
Cette API retourne les status de la tâche de préparation 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 depuis été supprimés du pool. Si cette API est appelée sur un travail qui n’a pas de tâche de préparation ou de mise en production de travail, le service Batch retourne le code HTTP status 409 (Conflit) avec un code d’erreur JobPreparationTaskNotSpecified.
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
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
batch
|
path | True |
string |
URL de base pour toutes les demandes de service Azure Batch. |
job
|
path | True |
string |
ID du travail. |
api-version
|
query | True |
string |
Version de l’API cliente. |
$filter
|
query |
string |
Clause de $filter OData. Pour plus d’informations sur la construction de ce filtre, consultez https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status. |
|
$select
|
query |
string |
Clause de $select OData. |
|
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 que le serveur peut consacrer au traitement de la demande, en secondes. La valeur par défaut est 30 secondes. |
En-tête de la demande
Media Types: "application/json; odata=minimalmetadata"
Nom | Obligatoire | Type | Description |
---|---|---|---|
client-request-id |
string uuid |
Identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration telle que des accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Indique si le serveur doit retourner le 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 d’horloge système actuelle ; définissez-la explicitement si vous appelez l’API REST directement. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Réponse contenant la liste des états de la préparation du travail et de la tâche de mise en production. En-têtes
|
|
Other Status Codes |
Erreur du service Batch. Si cette API est appelée sur un travail qui n’a pas de tâche de préparation ou de mise en production de travail, le service Batch retourne le code HTTP status 409. |
Sécurité
azure_auth
Microsoft Entra flux de code d’authentification 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
GET account.region.batch.azure.com/jobs/jobId/jobpreparationandreleasetaskstatus?api-version=2023-11-01.18.0
Exemple de réponse
{
"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"
}
Définitions
Nom | Description |
---|---|
Batch |
Réponse d’erreur reçue du service Azure Batch. |
Batch |
Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch. |
Cloud |
Résultat de la liste des status des tâches de préparation et de mise en production d’un travail. |
Error |
Catégorie de l’erreur. |
Error |
Message d’erreur reçu dans une réponse d’erreur Azure Batch. |
Job |
La status des tâches de préparation et de mise en production du travail sur un nœud de calcul. |
Job |
Contient des informations sur l’exécution d’une tâche de préparation de travail sur un nœud de calcul. |
Job |
État actuel de la tâche de préparation du travail sur le nœud de calcul. |
Job |
Contient des informations sur l’exécution d’une tâche de mise en production de travail sur un nœud de calcul. |
Job |
État actuel de la tâche de mise en production du travail sur le nœud de calcul. |
Name |
Représente une paire nom-valeur. |
Task |
Contient des informations sur le conteneur qu’une tâche est en cours d’exécution. |
Task |
Résultat de l’exécution de la tâche. |
Task |
Informations sur l’échec d’une 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 programmation. |
message |
Message décrivant l’erreur, destiné à être affiché dans une interface utilisateur. |
|
values |
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 des status des tâches de préparation et de mise en production d’un travail.
Nom | Type | Description |
---|---|---|
odata.nextLink |
string |
URL permettant d’obtenir l’ensemble de résultats suivant. |
value |
Liste des informations sur la préparation du travail et l’exécution des tâches de mise en production. |
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 utilisateur, tel qu’une 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
La status des tâches de préparation et de mise en production du travail sur un nœud de calcul.
Nom | Type | Description |
---|---|---|
jobPreparationTaskExecutionInfo |
Informations sur l’exécution status de la tâche de préparation du travail sur ce nœud de calcul. |
|
jobReleaseTaskExecutionInfo |
Informations sur l’exécution status de la tâche de mise en production du travail sur ce 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 de travail sur un nœud de calcul.
Nom | Type | Description |
---|---|---|
containerInfo |
Informations sur le conteneur sous lequel la tâche s’exécute. |
|
endTime |
string |
Heure à laquelle la tâche de préparation du travail s’est terminée. |
exitCode |
integer |
Code de sortie du programme spécifié sur la ligne de commande Tâche. |
failureInfo |
Informations décrivant l’échec de la tâche, le cas échéant. |
|
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. |
result |
Résultat de l’exécution de la tâche. |
|
retryCount |
integer |
Nombre de tentatives de la tâche par le service Batch. Les échecs d’application de tâche (code de sortie non nul) sont retentés, les erreurs de prétraitement (impossible d’exécuter la tâche) et les erreurs de chargement de fichier ne sont pas retentées. Le service Batch retentera la tâche jusqu’à la limite spécifiée par les contraintes. |
startTime |
string |
Heure à laquelle la tâche a commencé à s’exécuter. |
state |
É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 de la tâche (telles que des échecs de téléchargement du fichier de ressources). |
running |
string |
La tâche est en cours d’exécution (y compris une nouvelle tentative). |
JobReleaseTaskExecutionInformation
Contient des informations sur l’exécution d’une tâche de mise en production de travail sur un nœud de calcul.
Nom | Type | Description |
---|---|---|
containerInfo |
Informations sur le conteneur sous lequel la tâche s’exécute. |
|
endTime |
string |
Heure à laquelle la tâche de mise en production du travail s’est terminée. |
exitCode |
integer |
Code de sortie du programme spécifié sur la ligne de commande Tâche. |
failureInfo |
Informations décrivant l’échec de la tâche, le cas échéant. |
|
result |
Résultat de l’exécution de la tâche. |
|
startTime |
string |
Heure à laquelle la tâche a commencé à s’exécuter. |
state |
É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 de la tâche (telles que des échecs de téléchargement du fichier de ressources). |
running |
string |
La tâche est en cours d’exécution (y compris une nouvelle tentative). |
NameValuePair
Représente une paire nom-valeur.
Nom | Type | Description |
---|---|---|
name |
string |
Nom dans la paire nom-valeur. |
value |
string |
Valeur dans la paire nom-valeur. |
TaskContainerExecutionInformation
Contient des informations sur le conteneur qu’une tâche est en cours d’exécution.
Nom | Type | Description |
---|---|---|
containerId |
string |
ID du conteneur. |
error |
string |
Informations d’erreur détaillées sur le conteneur. |
state |
string |
État du conteneur. |
TaskExecutionResult
Résultat de l’exécution de la tâche.
Nom | Type | Description |
---|---|---|
failure |
string |
Une erreur s’est produite pendant le traitement de la tâche. L’échec peut s’être produit avant le lancement du processus task, pendant l’exécution du processus task ou après la fermeture du processus de tâche. |
success |
string |
La tâche s’est exécutée avec succès. |
TaskFailureInformation
Informations sur l’échec d’une tâche.
Nom | Type | Description |
---|---|---|
category |
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 programmation. |
details |
Liste des détails supplémentaires liés à l’erreur. |
|
message |
string |
Message décrivant l’erreur de tâche, destiné à être affiché dans une interface utilisateur. |