Ce document explique comment afficher les tâches et les jobs Batch.
Avant de commencer
- Si vous n'avez jamais utilisé Batch auparavant, consultez la page 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 tâches et les tâches, demandez à votre administrateur de vous attribuer le rôle IAM "Lecteur de tâches par lot" (
roles/batch.jobsViewer
) ou "Éditeur de tâches par lot" (roles/batch.jobsEditor
) sur le projet. Pour en savoir plus sur l'attribution de rôles, consultez la section Gérer les accès.Vous pouvez également obtenir les autorisations requises via des rôles personnalisés ou d'autres rôles prédéfinis.
Afficher vos offres d'emploi
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 une liste de vos jobs
Vous pouvez afficher la liste des tâches du projet en cours à l'aide de la console Google Cloud, de gcloud CLI, de l'API Batch, de Go, Java, Node.js, Python ou C++.
Console
Pour afficher la liste des tâches du projet en cours à l'aide de la console Google Cloud, accédez à la page Liste des tâches.
La liste des jobs peut comporter 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 la commande suivante:
Status:JOB_STATE
Remplacez
JOB_STATE
par un état de la tâche, par exempleFAILED
.
gcloud
Afficher toutes les tâches
Pour afficher la liste des tâches du projet en cours à l'aide de la gcloud CLI, exécutez 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 des tâches:
Pour n'afficher que les tâches d'un emplacement spécifique, incluez l'option
--location
.Pour n'afficher que les tâches basées sur une expression de filtre, spécifiez l'option
--filter
.
Par exemple, exécutez la commande suivante :
gcloud batch jobs list \
--location=LOCATION \
--filter="FILTER_EXPRESSION"
Remplacez les éléments suivants :
LOCATION
: emplacement où se trouvent une ou plusieurs offres d'emploi.FILTER_EXPRESSION
: expression de filtre qui définit les tâches que vous souhaitez répertorier. 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
).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 dans un état spécifique, utilisez l'expression de filtre suivante:
status.state="JOB_STATE"
Remplacez
JOB_STATE
par un état de la tâche, par exempleFAILED
.Filtrer en fonction des étiquettes:supposons que votre projet ait défini les étiquettes personnalisées suivantes:
Pour indiquer les tâches et leurs ressources créées par votre équipe de recherche lorsque vous consultez des rapports Cloud Billing, certaines de vos tâches et leurs ressources possèdent un libellé
team
défini surresearch
.Pour indiquer des charges de travail urgentes, certaines tâches comportent un libellé
deadline
, défini sur différentes valeurs.Pour indiquer que votre équipe de développement a testé avec succès des exécutables, certains 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:
Tâches issues de l'équipe de recherche, dont le libellé
team
est défini dans la règle d'allocation définie surresearch
Emplois qui répondent à au moins l'un des critères suivants:
Les tâches urgentes, dont le libellé
deadline
est défini sur n'importe quelle valeur.Les tâches comportant au moins un exécutable dont le test a réussi, c'est-à-dire les jobs dont au moins un exécutable avec un libellé
tested
défini surtrue
.
API
Afficher toutes les tâches
Pour afficher la liste des tâches du projet en cours 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 où existent les tâches.
Afficher une liste filtrée de jobs
Vous pouvez éventuellement spécifier le paramètre de requête filter
pour afficher une liste filtrée des tâches en fonction d'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 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
).
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 dans un état spécifique, utilisez l'expression de filtre suivante:
status.state="JOB_STATE"
Remplacez
JOB_STATE
par un état de la tâche, par exempleFAILED
.Filtrer en fonction des étiquettes:supposons que votre projet ait défini les étiquettes personnalisées suivantes:
Pour indiquer les tâches et leurs ressources créées par votre équipe de recherche lorsque vous consultez des rapports Cloud Billing, certaines de vos tâches et leurs ressources possèdent un libellé
team
défini surresearch
.Pour indiquer des charges de travail urgentes, certaines tâches comportent un libellé
deadline
, défini sur différentes valeurs.Pour indiquer que votre équipe de développement a testé avec succès des exécutables, certains 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 répertorie que les tâches qui répondent à tous les critères suivants:
Tâches issues de l'équipe de recherche, dont le libellé
team
est défini dans la règle d'allocation définie surresearch
Emplois qui répondent à au moins l'un des critères suivants:
Les tâches urgentes, dont le libellé
deadline
est défini sur n'importe quelle valeur.Les tâches comportant au moins un exécutable dont le test a réussi, c'est-à-dire les jobs dont 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'une tâche dans le projet en cours à l'aide de la console Google Cloud, de gcloud CLI, de l'API Batch, de 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 Job name (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 en savoir plus, cliquez sur "Autres onglets".
gcloud
Pour afficher les détails d'une tâche dans le projet en cours à l'aide de la gcloud CLI, exécutez la commande gcloud batch jobs describe
avec l'option --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ù se trouve la tâche.
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 du projet en coursLOCATION
: emplacement où se trouve la tâche.JOB_NAME
: nom d'une tâche existante.
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'une de vos tâches, sélectionnez l'une des méthodes suivantes:
Pour afficher toutes les tâches d'une tâche ou d'un groupe de tâches, affichez la liste des tâches d'une tâche.
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'une mission
Vous pouvez afficher la liste des tâches d'une tâche ou d'un groupe de tâches à l'aide de la console Google 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 une tâche ou un groupe de tâches (par exemple, pour ne répertorier que les tâches dont l'exécution a réussi), 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 Informations sur la tâche. Consultez ensuite la section Détails de la tâche.
gcloud
Pour afficher la liste des tâches d'un groupe de tâches à l'aide de la 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ù se trouve le job.
Vous pouvez éventuellement ajouter l'option --filter
pour afficher une liste filtrée des tâches d'un 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 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'une tâche en cours d'exécution ou dont l'exécution a abouti:
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
: ID du projet en coursLOCATION
: emplacement où se trouve 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 éventuellement 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'une tâche en fonction d'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/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'une tâche en cours d'exécution ou dont l'exécution a abouti:
STATE=RUNNING%20OR%20STATE=SUCCEEDED
Notez que l'expression de filtre encodée en URL représente l'expression de filtre décodée suivante:
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 console Google 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 console Google Cloud, affichez les détails d'une tâche pour ouvrir la page Informations sur 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 la gcloud CLI, exécutez la commande gcloud batch tasks describe
avec les options suivantes:
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 la tâche commence à 0 pour la première 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 index0
,1
,2
et3
.TASK_GROUP_NAME
: nom du groupe de tâches qui contient 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ù se trouve le 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 en coursLOCATION
: emplacement où se trouve la tâche.JOB_NAME
: nom d'une tâche existante.TASK_GROUP_NAME
: nom du groupe de tâches qui contient 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 la tâche commence à 0 pour la première 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 index0
,1
,2
,3
.
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
Apprenez à surveiller et à analyser des jobs:
Surveillez et optimisez les ressources de tâches en affichant les métriques.
Si vous avez configuré des journaux pour une tâche, vous pouvez analyser une tâche à l'aide des 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 organiser les ressources à l'aide d'étiquettes.
Découvrez comment supprimer et exporter des tâches.