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 par lot (
roles/batch.jobsViewer
) ou Éditeur de jobs par lot (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 via des rôles personnalisés ou d'autres rôles prédéfinis.
Afficher vos tâches
Pour afficher vos tâches, sélectionnez l'une des méthodes suivantes :
Pour afficher toutes les tâches de votre projet, affichez la liste de vos tâches.
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 de vos tâches
Vous pouvez afficher la liste des tâches du projet en cours à l'aide de la la console Google Cloud, gcloud CLI, l'API Batch, Go, Java, Node.js, Python ou C++.
Console
Pour afficher la liste des tâches du projet en cours à l'aide de la méthode Dans la console Google Cloud, accédez à la page Liste des tâches.
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 jobs, cliquez sur
Filtre : Saisissez ou sélectionnez ensuite une propriété et une valeur.Par exemple, pour filtrer la liste afin de n'inclure que les offres d'emploi d'un poste saisissez la commande suivante:
Status:JOB_STATE
Remplacez
JOB_STATE
par un état de tâche (par exemple,FAILED
).
gcloud
Afficher toutes les tâches
Pour afficher la liste des tâches du projet en cours à l'aide de la méthode
gcloud CLI, utilisez la
Commande gcloud batch jobs list
gcloud batch jobs list
Afficher une liste filtrée des jobs
Vous pouvez éventuellement ajouter un ou plusieurs indicateurs pour afficher une liste filtrée des tâches:
Pour n'afficher que les tâches d'un emplacement spécifique, incluez l'option
--location
.Pour afficher uniquement les tâches 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 d'une ou de plusieurs tâches.FILTER_EXPRESSION
: a expression de filtre qui définit les tâches que vous souhaitez répertorier. L'expression de filtre doit en définir une ou plusieurs paires propriété-valeur séparées par zéro ou plusieurs opérateurs booléens (AND
,OR
etNOT
).Vous pouvez par exemple consulter les expressions de filtre suivantes:
Filtrer en fonction de l'état de la tâche:pour n'afficher que les tâches se trouvant dans un un état spécifique, utilisez l'expression de filtre suivante:
status.state="JOB_STATE"
Remplacez
JOB_STATE
par un état de tâche (par exemple,FAILED
).Filtrer en fonction des libellés: Supposons que votre projet ait défini les champs personnalisés suivants étiquettes:
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 de leurs ressources ont un libellé
team
défini surresearch
.Pour indiquer des charges de travail urgentes, certaines tâches ont un
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 ont 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 répertorie que les tâches qui répondent à tous les critères suivants critères:
Emplois issus de l'équipe de recherche, et portant le libellé
team
la règle d'allocation du job définie 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 n'importe quelle valeur.Tâches ayant au moins un exécutable qui a été testé avec succès, c'est-à-dire des tâches ayant au moins un exécutable avec un libellé
tested
défini surtrue
.
API
Afficher toutes les tâches
Pour afficher la liste des jobs du projet actuel pour un emplacement spécifique à l'aide de
l'API Batch, envoyez une requête GET
au
Méthode jobs.list
.
GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs
Remplacez les éléments suivants :
PROJECT_ID
: le ID du projet de votre projet actuel.LOCATION
: emplacement où les emplois existent.
Afficher une liste filtrée des jobs
Vous pouvez également spécifier le paramètre de requête filter
pour afficher une liste filtrée d'offres d'emploi, basée sur une expression de filtre.
Par exemple, exécutez 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 un
expression de filtre
qui utilise l'encodage URL.
L'expression de filtre doit définir une ou plusieurs paires propriété-valeur
séparés par zéro ou plus
opérateurs booléens (AND
, OR
et NOT
).
Vous pouvez par exemple consulter les expressions de filtre suivantes:
Filtrer en fonction de l'état de la tâche:pour n'afficher que les tâches se trouvant dans un un état spécifique, utilisez l'expression de filtre suivante:
status.state="JOB_STATE"
Remplacez
JOB_STATE
par un état du job, pour exemple :FAILED
.Filtrer en fonction des libellés : imaginons que votre projet ait défini les libellés personnalisés suivants :
Pour indiquer les emplois et leurs ressources qui sont créés par votre recherche lorsque vous consultez des rapports Cloud Billing, certains de vos jobs leurs ressources possèdent un libellé
team
défini surresearch
.Pour indiquer des charges de travail urgentes, certaines tâches ont un
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 ont 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 tâches qui répondent à tous les critères suivants :
Emplois issus de l'équipe de recherche, et portant le libellé
team
la règle d'allocation du job définie 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 n'importe quelle valeur.Les jobs dont au moins un exécutable a été correctement configuré Il s'agit des jobs dont au moins un exécutable avec Libellé
tested
défini surtrue
.
Go
Go
Pour en savoir plus, consultez la documentation de référence de l'API Go par lot.
Pour vous authentifier auprès de Batch, configurez le service 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 les API Java par lot documentation de référence.
Pour vous authentifier auprès de Batch, configurez le service 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 les API Node.js par lot documentation de référence.
Pour vous authentifier auprès de Batch, configurez le service 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 les API Python par lot documentation de référence.
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 C++ par lot.
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'un job dans le projet en cours à l'aide de la la console Google Cloud, gcloud CLI, l'API Batch, Go, Java, Node.js, Python ou C++.
Console
Pour afficher les détails d'une tâche dans le projet en cours à l'aide de la console Google Cloud, procédez comme suit :
Dans la console Google Cloud, accédez à la page Liste des tâches.
Dans la colonne Nom de la tâche, cliquez sur le nom d'une tâche.
La page "Job Details" (informations sur le job) s'ouvre alors.
L'onglet Détails est ouvert par défaut. Pour plus d'informations, cliquez sur d'autres onglets.
gcloud
Pour afficher les détails d'une tâche dans le projet en cours à l'aide de la
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'une tâche existante.LOCATION
: emplacement où le job existe.
API
Pour afficher les détails d'une tâche dans le projet en cours à 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 de projet du projet en cours.LOCATION
: emplacement où le job existe.JOB_NAME
: nom d'une tâche existante.
Go
Go
Pour en savoir plus, consultez la documentation de référence de l'API Go par lot.
Pour vous authentifier auprès de Batch, configurez le service 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 les API Java par lot documentation de référence.
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 les API Node.js par lot documentation de référence.
Pour vous authentifier auprès de Batch, configurez le service 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 les API Python par lot documentation de référence.
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 les API C++ par lot documentation de référence.
Pour vous authentifier auprès de Batch, configurez le service 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'une de vos tâches, sélectionnez l'une des méthodes suivantes :
Pour afficher toutes les tâches d'un job ou d'un groupe de tâches, affichez la liste des tâches d'un job.
Pour afficher tous les détails de configuration d'une tâche spécifique, Afficher les détails d'une tâche
Afficher la liste des tâches d'une mission
Vous pouvez afficher la liste des tâches d'un job ou d'un groupe de tâches à l'aide de la console Google Cloud, de la Google Cloud 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 une tâche ou dans le groupe de tâches d'une tâche (par exemple, pour n'afficher que les tâches qui ont bien été exécutées), vous devez utiliser la gcloud CLI ou l'API Batch.
Console
Pour afficher un résumé des tâches d'une tâche à l'aide de la console Google Cloud, affichez les détails d'une tâche pour ouvrir la page Détails de la tâche. Consultez ensuite la section Détails de la tâche.
gcloud
Pour afficher la liste des tâches du groupe de tâches d'une tâche à l'aide de gcloud CLI, exécutez la commande gcloud batch tasks list
avec les options suivantes :
gcloud batch tasks list \
--job=JOB_NAME \
--location=LOCATION
Remplacez les éléments suivants :
JOB_NAME
: nom d'une tâche existante.LOCATION
: emplacement où le job existe.
Vous pouvez éventuellement ajouter l'option --filter
pour afficher une liste filtrée des tâches.
dans le groupe de tâches d'une tâche 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 un
expression de filtre.
Par exemple, vous pouvez spécifier l'expression de filtre suivante pour n'afficher que les tâches du groupe de tâches d'une tâche en cours d'exécution ou terminées :
STATE=RUNNING OR STATE=SUCCEEDED
API
Pour afficher la liste des tâches d'un groupe de tâches d'une tâche à 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
: le ID du projet du projet en cours.LOCATION
: emplacement de la tâche.JOB_NAME
: nom d'une tâche existante.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 du groupe de tâches d'une tâche, 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/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 du groupe de tâches d'une tâche en cours d'exécution ou terminées :
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 les API Go par lot documentation de référence.
Pour vous authentifier auprès de Batch, configurez le service 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 Java par lot.
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 Node.js par lot.
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 les API Python par lot documentation de référence.
Pour vous authentifier auprès de Batch, configurez le service 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 les API C++ par lot documentation de référence.
Pour vous authentifier auprès de Batch, configurez le service 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 la console Google Cloud, gcloud CLI, l'API Batch, Go, Java, Node.js, Python ou C++.
Console
Pour afficher les détails d'une tâche à l'aide de la console Google Cloud, affichez les détails d'un job pour ouvrez la page Détails de la tâche. 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, exécutez 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 que vous souhaitez afficher. dans les détails. Dans un groupe de tâches, l'index de la tâche commence à 0 pour le premier tâche et augmente de 1 à chaque tâche supplémentaire. Par exemple, un groupe de tâches contenant quatre tâches possède les indices0
,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'une tâche existante.LOCATION
: emplacement où le job existe.
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 de projet du projet en cours.LOCATION
: emplacement où le job existe.JOB_NAME
: nom d'une tâche existante.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 souhaitée. pour afficher les détails. Dans un groupe de tâches, l'indice 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
, un,3
Go
Go
Pour en savoir plus, consultez la documentation de référence de l'API Go par lot.
Pour vous authentifier auprès de Batch, configurez le service 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 Java par lot.
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 Node.js par lot.
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 les API Python par lot documentation de référence.
Pour vous authentifier auprès de Batch, configurez le service 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 les API C++ par lot documentation de référence.
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.
Étape suivante
En savoir plus sur le dépannage
Découvrez comment surveiller et analyser les tâches :
Surveillez et optimisez les ressources de tâche en affichant les métriques.
Si vous avez configuré des journaux pour une tâche, vous pouvez analyser une tâche à l'aide de journaux.
Si vous avez configuré les notifications d'état, vous pouvez surveiller une tâche à l'aide des notifications Pub/Sub et analyser les notifications à l'aide de BigQuery.
Découvrez comment gérer les tâches :