Ce document explique comment afficher les tâches et les jobs Batch.
Avant de commencer
- Si vous n'avez jamais utilisé Batch, consultez Premiers pas avec Batch et activez Batch en remplissant les conditions préalables pour les projets et les utilisateurs.
-
Pour obtenir les autorisations nécessaires pour afficher les jobs et les tâches, demandez à votre administrateur de vous accorder le rôle IAM Lecteur de jobs Batch (
roles/batch.jobsViewer
) ou Éditeur de jobs Batch (roles/batch.jobsEditor
) sur le projet. Pour en savoir plus sur l'attribution de rôles, consultez la page Gérer l'accès aux projets, aux dossiers et aux organisations.Vous pouvez également obtenir les autorisations requises avec des rôles personnalisés ou d'autres rôles prédéfinis.
Afficher vos jobs
Pour afficher vos tâches, sélectionnez l'une des méthodes suivantes :
Pour afficher tous les jobs de votre projet, consultez la liste de vos jobs.
Pour afficher tous les détails de configuration d'un job spécifique, affichez les détails d'un job.
Afficher la liste de vos jobs
Vous pouvez afficher la liste des jobs dans le projet actuel à l'aide de la consoleGoogle Cloud , de gcloud CLI, de l'API Batch, de Go, de Java, de Node.js, de Python ou de C++.
Console
Pour afficher la liste des jobs du projet actuel à l'aide de la consoleGoogle Cloud , accédez à la page Liste des jobs.
La liste des tâches peut s'étendre sur plusieurs pages. Si vous devez passer à la page suivante, cliquez sur Suivant
en bas de l'écran.(Facultatif) Si vous souhaitez filtrer la liste des tâches, cliquez sur
Filtrer. Ensuite, saisissez ou sélectionnez une propriété et une valeur.Par exemple, pour filtrer la liste afin de n'inclure que les tâches dans un état spécifique, saisissez ce qui suit :
Status:JOB_STATE
Remplacez
JOB_STATE
par un état du job, par exempleFAILED
.
gcloud
Afficher toutes les tâches
Pour afficher la liste des jobs du projet actuel à l'aide de gcloud CLI, utilisez la commande gcloud batch jobs list
.
gcloud batch jobs list
Afficher une liste filtrée de jobs
Vous pouvez éventuellement ajouter un ou plusieurs indicateurs pour afficher une liste filtrée de jobs :
Pour n'afficher que les jobs dans un emplacement spécifique, incluez l'option
--location
.Pour n'afficher que les jobs en fonction d'une expression de filtre, spécifiez l'indicateur
--filter
.
Par exemple, exécutez la commande suivante :
gcloud batch jobs list \
--location=LOCATION \
--filter="FILTER_EXPRESSION"
Remplacez les éléments suivants :
LOCATION
: emplacement dans lequel un ou plusieurs jobs existent.FILTER_EXPRESSION
: expression de filtre qui définit les jobs que vous souhaitez lister. L'expression de filtre doit définir une ou plusieurs paires propriété-valeur séparées par zéro ou plusieurs opérateurs booléens (AND
,OR
etNOT
).Par exemple, consultez les expressions de filtre suivantes :
Filtrer en fonction de l'état du job : pour n'afficher que les jobs qui se trouvent dans un état spécifique, utilisez l'expression de filtre suivante :
status.state="JOB_STATE"
Remplacez
JOB_STATE
par un état du job, par exempleFAILED
.Filtrer en fonction des libellés : Supposons que votre projet ait défini les libellés personnalisés suivants :
Pour indiquer les jobs et leurs ressources créés par votre équipe de recherche lorsque vous consultez les rapports Cloud Billing, certains de vos jobs et leurs ressources sont associés à un libellé
team
défini surresearch
.Pour indiquer les charges de travail urgentes, certaines tâches sont associées à un libellé
deadline
, qui est défini sur différentes valeurs.Pour indiquer les exécutables que votre équipe de développement a testés avec succès, certains exécutables sont associés à un libellé
tested
défini surtrue
.
Vous pouvez ensuite spécifier l'expression de filtre suivante :
(allocationPolicy.labels.team=research) AND ((labels.deadline:*) OR (runnables.labels.tested=true))
Cette expression de filtre ne liste que les jobs qui répondent à tous les critères suivants :
Tâches de l'équipe de recherche dont le libellé
team
de la règle d'attribution est défini surresearch
.Les jobs qui répondent à au moins l'un des critères suivants :
Tâches urgentes, qui comportent un libellé
deadline
défini sur une valeur quelconque.Jobs comportant au moins un exécutable qui a été testé avec succès, c'est-à-dire les jobs comportant au moins un exécutable avec un libellé
tested
défini surtrue
.
API
Afficher toutes les tâches
Pour afficher la liste des jobs dans le projet actuel pour un emplacement spécifique à l'aide de l'API Batch, envoyez une requête GET
à la méthode jobs.list
.
GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs
Remplacez les éléments suivants :
PROJECT_ID
: ID de projet de votre projet actuel.LOCATION
: emplacement des jobs.
Afficher une liste filtrée de jobs
Vous pouvez également spécifier le paramètre de requête filter
pour afficher une liste filtrée de jobs, basée sur une expression de filtre.
Par exemple, envoyez la requête GET
suivante :
GET https://batch.googleapis.com/v1/projects/example-project/locations/us-central1/jobs?filter=FILTER_EXPRESSION
Remplacez FILTER_EXPRESSION
par une expression de filtre qui utilise l'encodage d'URL.
L'expression de filtre doit définir une ou plusieurs paires propriété-valeur séparées par zéro ou plusieurs opérateurs booléens (AND
, OR
et NOT
).
Par exemple, consultez les expressions de filtre suivantes :
Filtrer en fonction de l'état du job : pour n'afficher que les jobs qui se trouvent dans un état spécifique, utilisez l'expression de filtre suivante :
status.state="JOB_STATE"
Remplacez
JOB_STATE
par un état du job, par exempleFAILED
.Filtrer en fonction des libellés : Supposons que votre projet ait défini les libellés personnalisés suivants :
Pour indiquer les jobs et leurs ressources créés par votre équipe de recherche lorsque vous consultez les rapports Cloud Billing, certains de vos jobs et leurs ressources sont associés à un libellé
team
défini surresearch
.Pour indiquer les charges de travail urgentes, certaines tâches sont associées à un libellé
deadline
, qui est défini sur différentes valeurs.Pour indiquer les exécutables que votre équipe de développement a testés avec succès, certains exécutables sont associés à un libellé
tested
défini surtrue
.
Vous pouvez ensuite spécifier l'expression de filtre suivante :
(allocationPolicy.labels.team%3Dresearch)%20AND%20((labels.deadline%3A*)%20OR%20(runnables.labels.tested%3Dtrue))
Cette expression de filtre ne liste que les jobs qui répondent à tous les critères suivants :
Tâches de l'équipe de recherche dont le libellé
team
de la règle d'attribution est défini surresearch
.Les jobs qui répondent à au moins l'un des critères suivants :
Tâches urgentes, qui comportent un libellé
deadline
défini sur une valeur quelconque.Jobs comportant au moins un exécutable qui a été testé avec succès, c'est-à-dire les jobs comportant au moins un exécutable avec un libellé
tested
défini surtrue
.
Go
Go
Pour en savoir plus, consultez la documentation de référence de l'API Batch Go.
Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Java
Java
Pour en savoir plus, consultez la documentation de référence de l'API Batch Java.
Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Node.js
Node.js
Pour en savoir plus, consultez la documentation de référence de l'API Batch Node.js.
Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Python
Python
Pour en savoir plus, consultez la documentation de référence de l'API Batch Python.
Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
C++
C++
Pour en savoir plus, consultez la documentation de référence de l'API Batch C++.
Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Afficher les détails d'un job
Vous pouvez afficher les détails d'un job dans le projet actuel à l'aide de la consoleGoogle Cloud , de gcloud CLI, de l'API Batch, ou des langages Go, Java, Node.js, Python ou C++.
Console
Pour afficher les détails d'un job dans le projet actuel à l'aide de la consoleGoogle Cloud , procédez comme suit :
Dans la console Google Cloud , accédez à la page Liste des jobs.
Dans la colonne Nom du job, cliquez sur le nom d'un job.
La page "Job Details" (informations sur le job) s'ouvre alors.
L'onglet Détails est ouvert par défaut. Pour en savoir plus, cliquez sur les autres onglets.
gcloud
Pour afficher les détails d'un job dans le projet actuel à l'aide de gcloud CLI, utilisez la commande gcloud batch jobs describe
avec l'indicateur --location
.
gcloud batch jobs describe JOB_NAME \
--location=LOCATION
Remplacez les éléments suivants :
JOB_NAME
: nom d'un job existant.LOCATION
: emplacement du job.
API
Pour afficher les détails d'un job dans le projet actuel à l'aide de l'API Batch, envoyez une requête GET
à la méthode jobs.get
.
GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs/JOB_NAME
Remplacez les éléments suivants :
PROJECT_ID
: ID du projet actuel.LOCATION
: emplacement du job.JOB_NAME
: nom d'un job existant.
Go
Go
Pour en savoir plus, consultez la documentation de référence de l'API Batch Go.
Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Java
Java
Pour en savoir plus, consultez la documentation de référence de l'API Batch Java.
Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Node.js
Node.js
Pour en savoir plus, consultez la documentation de référence de l'API Batch Node.js.
Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Python
Python
Pour en savoir plus, consultez la documentation de référence de l'API Batch Python.
Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
C++
C++
Pour en savoir plus, consultez la documentation de référence de l'API Batch C++.
Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Afficher les tâches
Pour afficher les tâches d'un de vos jobs, sélectionnez l'une des méthodes suivantes :
Pour afficher toutes les tâches d'un job ou d'un groupe de tâches, consultez la liste des tâches d'un job.
Pour afficher tous les détails de configuration d'une tâche spécifique, affichez les détails d'une tâche.
Afficher la liste des tâches d'un job
Vous pouvez afficher la liste des tâches d'un job ou d'un groupe de tâches d'un job à l'aide de la consoleGoogle Cloud , de gcloud CLI, de l'API Batch, de Go, de Java, de Node.js, de Python ou de C++.
Si vous souhaitez filtrer une liste de tâches dans un job ou un groupe de tâches d'un job (par exemple, pour n'afficher que les tâches qui se sont terminées avec succès), vous devez utiliser la gcloud CLI ou l'API Batch.
Console
Pour afficher un récapitulatif des tâches d'un job à l'aide de la consoleGoogle Cloud , affichez les détails d'un job pour ouvrir la page Informations sur le job. Consultez ensuite la section Détails de la tâche.
gcloud
Pour afficher la liste des tâches d'un groupe de tâches d'un job à l'aide de gcloud CLI, utilisez la commande gcloud batch tasks list
avec les indicateurs suivants :
gcloud batch tasks list \
--job=JOB_NAME \
--location=LOCATION
Remplacez les éléments suivants :
JOB_NAME
: nom d'un job existant.LOCATION
: emplacement du job.
Vous pouvez également ajouter l'option --filter
pour afficher une liste filtrée des tâches d'un groupe de tâches d'un job, en fonction d'une expression de filtre.
Par exemple, exécutez la commande suivante :
gcloud batch tasks list \
--job=example-job \
--location=us-central1 \
--filter="FILTER_EXPRESSION"
Remplacez FILTER_EXPRESSION
par une expression de filtre.
Par exemple, vous pouvez spécifier l'expression de filtre suivante pour n'afficher que les tâches d'un groupe de tâches d'un job qui sont en cours d'exécution ou qui ont été exécutées avec succès :
STATE=RUNNING OR STATE=SUCCEEDED
API
Pour afficher la liste des tâches d'un groupe de tâches d'un job à l'aide de l'API Batch, envoyez une requête GET
à la méthode tasks.list
:
GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs/JOB_NAME/taskGroups/TASK_GROUP_NAME/tasks
Remplacez les éléments suivants :
PROJECT_ID
: ID du projet actuel.LOCATION
: emplacement du job.JOB_NAME
: nom d'un job existant.TASK_GROUP_NAME
: nom du groupe de tâches dont vous souhaitez afficher les détails. La valeur doit être définie surgroup0
.
Vous pouvez également spécifier le paramètre de requête filter
pour afficher une liste filtrée des tâches d'un groupe de tâches d'un job, en fonction d'une expression de filtre.
Par exemple, envoyez la requête GET
suivante :
GET https://batch.googleapis.com/v1/projects/example-project/locations/us-central1/jobs/example-job/taskGroups/group0/tasks?filter=FILTER_EXPRESSION
Remplacez FILTER_EXPRESSION
par une expression de filtre qui utilise l'encodage d'URL.
Par exemple, vous pouvez spécifier l'expression de filtre suivante pour n'afficher que les tâches d'un groupe de tâches d'un job qui sont en cours d'exécution ou qui ont été exécutées avec succès :
STATE=RUNNING%20OR%20STATE=SUCCEEDED
Notez que l'expression de filtre encodée au format URL correspond à l'expression de filtre décodée ci-après :
STATE=RUNNING OR STATE=SUCCEEDED
Go
Go
Pour en savoir plus, consultez la documentation de référence de l'API Batch Go.
Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Java
Java
Pour en savoir plus, consultez la documentation de référence de l'API Batch Java.
Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Node.js
Node.js
Pour en savoir plus, consultez la documentation de référence de l'API Batch Node.js.
Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Python
Python
Pour en savoir plus, consultez la documentation de référence de l'API Batch Python.
Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
C++
C++
Pour en savoir plus, consultez la documentation de référence de l'API Batch C++.
Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Afficher les détails d'une tâche
Vous pouvez afficher les détails d'une tâche à l'aide de la consoleGoogle Cloud , de gcloud CLI, de l'API Batch, de Go, de Java, de Node.js, de Python ou de C++.
Console
Pour afficher les détails d'une tâche à l'aide de la consoleGoogle Cloud , affichez les détails d'un job pour ouvrir la page Informations sur le job. Consultez ensuite la section Détails de la tâche.
gcloud
Pour afficher les détails d'une tâche à l'aide de gcloud CLI, utilisez la commande gcloud batch tasks describe
avec les indicateurs suivants :
gcloud batch tasks describe TASK_INDEX \
--location=LOCATION \
--job=JOB_NAME \
--task_group=TASK_GROUP_NAME
Remplacez les éléments suivants :
TASK_INDEX
: index de la tâche dont vous souhaitez afficher les détails. Dans un groupe de tâches, l'index de tâche commence à 0 pour la première tâche et augmente de 1 pour chaque tâche supplémentaire. Par exemple, un groupe de tâches contenant quatre tâches possède les index0
,1
,2
et3
.TASK_GROUP_NAME
: nom du groupe de tâches contenant la tâche dont vous souhaitez afficher les détails. La valeur doit être définie surgroup0
.JOB_NAME
: nom d'un job existant.LOCATION
: emplacement du job.
API
Pour afficher les détails d'une tâche à l'aide de l'API Batch, envoyez une requête GET
à la méthode tasks.get
:
GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs/JOB_NAME/taskGroups/TASK_GROUP_NAME/tasks/TASK_INDEX
Remplacez les éléments suivants :
PROJECT_ID
: ID du projet actuel.LOCATION
: emplacement du job.JOB_NAME
: nom d'un job existant.TASK_GROUP_NAME
: nom du groupe de tâches contenant la tâche dont vous souhaitez afficher les détails. La valeur doit être définie surgroup0
.TASK_INDEX
: index de la tâche dont vous souhaitez afficher les détails. Dans un groupe de tâches, l'index de tâche commence à 0 pour la première tâche et augmente de 1 pour chaque tâche supplémentaire. Par exemple, un groupe de tâches contenant quatre tâches possède les index0
,1
,2
et3
.
Go
Go
Pour en savoir plus, consultez la documentation de référence de l'API Batch Go.
Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Java
Java
Pour en savoir plus, consultez la documentation de référence de l'API Batch Java.
Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Node.js
Node.js
Pour en savoir plus, consultez la documentation de référence de l'API Batch Node.js.
Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Python
Python
Pour en savoir plus, consultez la documentation de référence de l'API Batch Python.
Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
C++
C++
Pour en savoir plus, consultez la documentation de référence de l'API Batch C++.
Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Étapes suivantes
En savoir plus sur le dépannage
Découvrez comment surveiller et analyser les jobs :
Surveillez et optimisez les ressources de vos jobs en consultant les métriques.
Si vous avez configuré des journaux pour un job, vous pouvez analyser un job à l'aide des journaux.
Si vous avez configuré des notifications d'état, vous pouvez surveiller un job à l'aide des notifications Pub/Sub et analyser les notifications à l'aide de BigQuery.
Découvrez comment gérer les tâches :