Les gestionnaires Cloud Tasks peuvent être exécutés sur n'importe quel point de terminaison HTTP avec une adresse IP externe comme GKE, Compute Engine ou même un serveur Web sur site. Votre les tâches peuvent être exécutées sur n'importe lequel de ces services mode.
Cette page explique comment créer par programmation des tâches HTTP cibles de base et placez-les Files d'attente Cloud Tasks
Pour les tâches comportant des cibles HTTP (par opposition aux cibles App Engine explicites, qui sont moins courantes), il existe deux façons de créer des tâches:
Méthode
BufferTask
:utilisez cette méthode si votre file d'attente est configurée pour des tâches à mettre en mémoire tampon devant un service. La file d'attente doit disposer d'un routage au niveau de la file d'attente. Dans la plupart des cas d'utilisation, il s'agit de la meilleure approche. Cette approche utiliseBufferTask
.Méthode
CreateTask
:elle est plus complexe. Vous devez créer explicitement un objet de tâche. Utilisez cette méthode si les tâches de votre file d'attente ont des configurations de routage différentes. Dans ce cas, vous spécifiez le routage au niveau au niveau de la tâche et ne peut pas utiliser le routage au niveau de la file d'attente. Cette approche utiliseCreateTask
.
Création de tâches de base (méthode BufferTask
)
Cette section explique comment créer une tâche en envoyant une requête HTTP. La méthode
que vous utilisez s'appelle BufferTask
.
Limites
La méthode BufferTask
est soumise aux limites suivantes:
Bibliothèques clientes:la méthode
BufferTask
n'est pas compatible avec les bibliothèques clientes bibliothèques.API RPC:la méthode
BufferTask
n'est pas compatible avec l'API RPC.Routage au niveau de la tâche:cette méthode n'est pas compatible avec le routage au niveau de la tâche. Depuis il n'y a nulle part où ajouter d'informations de routage lors de la création d'une tâche de cette façon, vous doit utiliser le routage au niveau de la file d'attente (sinon la tâche ne dispose pas d'informations de routage). Si votre file d'attente n'utilise pas déjà le routage au niveau de la file d'attente, consultez Configurez le routage au niveau de la file d'attente pour les tâches HTTP.
Appeler la méthode BufferTask
Les exemples suivants montrent comment créer une tâche en envoyant un POST
HTTP
à l'API Cloud Tasks
Point de terminaison buffer
.
Python
curl
L'extrait de code suivant montre un exemple de création de tâche à l'aide de la méthode
Méthode BufferTask
avec curl
:
curl -X HTTP_METHOD\ "https://cloudtasks.googleapis.com/v2/projects/PROJECT_ID/locations/LOCATION/queues/QUEUE_ID/tasks:buffer" \
Remplacez les éléments suivants :
HTTP_METHOD
: méthode HTTP de votre requête, pour Exemple :GET
ouPOST
.PROJECT_ID
: ID de votre projet Google Cloud. Pour l'obtenir, exécutez la commande suivante dans votre terminal:gcloud config get-value project
LOCATION
: emplacement de votre file d'attente.QUEUE_ID
: ID de votre file d'attente.
Création de tâches avancée (méthode CreateTask
)
Cette section explique comment créer une tâche en construisant l'objet tâche. Vous utilisez
la méthode CreateTask
.
Lorsque vous créez une tâche à l'aide de la méthode CreateTask
, vous créez et
définir l'objet de tâche. Vous devez spécifier le service et le gestionnaire qui traitent
la tâche.
Vous pouvez éventuellement transmettre des données spécifiques à la tâche au gestionnaire. Vous pouvez également d'affiner pour la tâche, comme prévoir une heure future où elle devra être exécutée ou limiter le nombre de tentatives d'exécution de la tâche en cas d'échec (voir Configuration avancée).
Les exemples suivants appellent la méthode CreateTask
pour créer une tâche à l'aide de la méthode
Bibliothèques clientes Cloud Tasks.
C#
Python
Notez le fichier requirements.txt
:
Java
Notez le fichier pom.xml
:
PHP
Notez le fichier composer.json
:
Go
Node.js
Notez le fichier package.json
:
Ruby
Configurer des comptes de service pour l'authentification des gestionnaires HTTP cibles
Cloud Tasks peut appeler les gestionnaires de cibles HTTP qui nécessitent l'authentification si vous disposez d'un compte de service avec les identifiants appropriés pour accéder au gestionnaire.
Si vous disposez déjà d'un compte de service, vous pouvez le faire. Accordez-lui simplement les rôles appropriés. Ces instructions concernent la création d'un compte de service spécifique pour cette fonction. Le compte de service nouveau ou existant utilisé pour l'authentification Cloud Tasks doit se trouver dans le même projet que vos files d'attente Cloud Tasks.
Dans Google Cloud Console, accédez à la page Comptes de service.
Si nécessaire, sélectionnez le projet approprié.
Cliquez sur Créer un compte de service.
Dans la section Détails du compte de service, attribuez un nom au compte. La console crée un nom de compte de messagerie associé au compte. C’est ainsi que faire référence au compte. Vous pouvez également ajouter une description du compte. . Cliquez sur Créer et continuer.
Dans la section Autoriser ce compte de service à accéder au projet, cliquez sur Sélectionnez un rôle. Recherchez et sélectionnez Empileur de tâches Cloud. Ce rôle accorde au compte de service l'autorisation d'ajouter des tâches à la file d'attente.
Cliquez sur + Ajouter un autre rôle.
Cliquez sur Select a role (Sélectionner un rôle). Recherchez et sélectionnez Utilisateur du compte de service. Ce permet au compte de service d'autoriser la file d'attente à créer des jetons sur en son nom à l'aide des identifiants du compte de service.
Si votre gestionnaire fait partie de Google Cloud, attribuez au compte de service le rôle associé à l'accès au service sur lequel votre gestionnaire s'exécute. Chaque service Google Cloud nécessite un rôle différent. Par exemple, pour accéder à un gestionnaire sur Cloud Run, vous devez utiliser le rôle Demandeur Cloud Run, et ainsi de suite. Vous pouvez utiliser le compte de service que vous venez de créer ou tout autre compte de service dans votre projet.
Cliquez sur OK pour terminer la création du compte de service.
Cloud Tasks lui-même doit posséder son propre compte de service doté du rôle Cloud Tasks Service Agent
. Cela lui permet de générer des jetons d'en-tête basés sur les identifiants associés au compte de service Cloud Tasks pour s'authentifier auprès de votre cible de gestionnaire. Le compte de service Cloud Tasks auquel ce rôle est attribué est automatiquement créé lorsque vous activez l'API Cloud Tasks, sauf si vous l'avez activée avant le 19 mars 2019, auquel cas vous devez ajouter le rôle manuellement.
Utiliser des tâches HTTP target avec des jetons d'authentification
Pour s'authentifier entre Cloud Tasks et une cible HTTP
nécessitant une telle authentification, Cloud Tasks crée
un jeton d'en-tête. Ce jeton est basé sur les identifiants
Compte de service Cloud Tasks Enqueuer
, identifié par son adresse e-mail. La
compte de service utilisé pour l'authentification doit faire partie du même
projet dans lequel réside votre file d'attente Cloud Tasks. La requête, avec le paramètre
est envoyé au gestionnaire via HTTPS depuis la file d'attente. Vous pouvez utiliser
Un jeton d'ID
ou un jeton d'accès.
Les jetons d'ID doivent généralement être utilisés
pour tout gestionnaire exécuté sur Google Cloud,
par exemple, sur Cloud Functions ou Cloud Run. La principale exception est
Pour les API Google hébergées sur *.googleapis.com
: ces API attendent un jeton d'accès.
Vous pouvez configurer l'authentification au niveau de la file d'attente ou au niveau de la tâche. À configurer l'authentification au niveau de la file d'attente, voir Créez des files d'attente Cloud Tasks. Si l'authentification est configurée au niveau de la file d'attente, cette configuration remplace au niveau de la tâche. Pour configurer l'authentification au niveau des tâches, spécifiez une Jeton d'ID (OIDC) ou jeton d'accès (OAuth) à la tâche lui-même.
Méthode BufferTask
Les exemples suivants utilisent les identifiants par défaut de l'application pour s'authentifier lorsque
à l'aide de la méthode BufferTask
pour créer une tâche.
Python
Dans l'exemple de code suivant, indiquez la valeur de votre jeton d'authentification.
curl
curl -X HTTP_METHOD\ "https://cloudtasks.googleapis.com/v2/projects/PROJECT_ID/locations/LOCATION/queues/QUEUE_ID/tasks:buffer" \ -H "Authorization: Bearer ACCESS_TOKEN"
Remplacez les éléments suivants :
HTTP_METHOD
: méthode HTTP de votre requête, pour Exemple :GET
ouPOST
.PROJECT_ID
: ID de votre projet Google Cloud. Pour l'obtenir, exécutez la commande suivante dans votre terminal:gcloud config get-value project
LOCATION
: emplacement de votre file d'attente.QUEUE_ID
: ID de votre file d'attente.ACCESS_TOKEN
: votre jeton d'accès Vous pouvez l'obtenir en en exécutant la commande suivante dans votre terminal:gcloud auth application-default login
gcloud auth application-default print-access-token
Méthode CreateTask
Les exemples suivants utilisent la méthode CreateTask
avec la
les bibliothèques clientes Cloud Tasks pour créer une tâche
inclut la création d'un jeton d'en-tête. Des jetons d'ID sont utilisés dans les exemples.
Pour utiliser un jeton d'accès, remplacez le paramètre OIDC par le langage approprié.
Paramètre OAuth lors de la création de la requête.
Python
Notez le fichier requirements.txt
:
Java
Notez le fichier pom.xml
:
Go
Node.js
Notez le fichier package.json
:
Fournir vos propres gestionnaires de tâches HTTP Target
Les gestionnaires de tâches HTTP Target ressemblent beaucoup aux gestionnaires de tâches App Engine, aux exceptions près suivantes :
- Délais avant expiration: pour tous les gestionnaires de tâches HTTP cibles, le délai avant expiration par défaut est de 10 minutes. avec un maximum de 30 minutes.
- Logique d'authentification: si vous écrivez votre propre code dans la classe pour valider le jeton, vous devez utiliser un jeton d'ID. Pour plus d'informations sur ce sujet, consultez la page OpenID Connect, en particulier la section Valider un jeton d'ID.
Headers (En-têtes) : une requête HTTP cible comporte des en-têtes définis par la file d'attente, qui contiennent informations spécifiques à la tâche que votre gestionnaire peut utiliser. Ils sont semblables aux en-têtes définis dans les requêtes de tâches App Engine, mais pas identiques. Ces en-têtes fournissent des informations uniquement. Ils ne doivent pas être utilisés comme sources d'identité.
Si ces en-têtes étaient présents dans une requête d'utilisateur externe adressée à votre application, ils sont remplacés par des en-têtes internes. La seule exception concerne les requêtes des administrateurs connectés à l'application, qui sont autorisés à définir des en-têtes à des fins de test.
Les requêtes HTTP target contiennent toujours les en-têtes suivants:
En-tête Description X-CloudTasks-QueueName
Nom de la file d'attente. X-CloudTasks-TaskName
Nom "court" de la tâche ou, si aucun nom n'a été spécifié lors de la création, identifiant unique généré par le système. Il s'agit de la valeur my-task-id
dans le nom complet de la tâche, par exemple task_name =projects/my-project-id/locations/my-location/queues/my-queue-id/tasks/my-task-id
.X-CloudTasks-TaskRetryCount
Nombre de fois où une tâche a fait l'objet de nouvelles tentatives d'exécution. Pour la première tentative, cette valeur est définie sur 0
. Ce chiffre inclut les tentatives lorsque la tâche a échoué en raison de codes d'erreur 5XX et n'a jamais atteint la phase d'exécution.X-CloudTasks-TaskExecutionCount
Nombre total de fois où la tâche a reçu une réponse du gestionnaire. Étant donné que Cloud Tasks supprime la tâche une fois la réponse reçue, toutes les réponses précédentes du gestionnaire sont des échecs. Ce chiffre n'inclut pas les échecs dus à des codes d'erreur 5XX. X-CloudTasks-TaskETA
Heure de planification de la tâche spécifiée en secondes depuis le 1er janvier 1970. En outre, les requêtes Cloud Tasks peuvent contenir les en-têtes suivants :
En-tête Description X-CloudTasks-TaskPreviousResponse
Code de réponse HTTP de la tentative précédente. X-CloudTasks-TaskRetryReason
Raison de la nouvelle tentative d'exécution de la tâche.
Ajouter manuellement le rôle d'agent de service Cloud Tasks à votre compte de service Cloud Tasks
Cela n'est nécessaire que si vous avez activé l'API Cloud Tasks avant le 19 mars 2019.
Utiliser la console
- Recherchez le numéro de votre projet sur la page des paramètres du projet Google Cloud.
- Copiez le numéro.
- Ouvrez la page Console d'administration IAM.
- Cliquez sur Accorder l'accès. L'écran Accorder l'accès s'ouvre.
Dans la section Ajouter des comptes principaux, ajoutez une adresse e-mail au format suivant:
service-PROJECT_NUMBER@gcp-sa-cloudtasks.iam.gserviceaccount.com
Remplacez PROJECT_NUMBER par le numéro de projet indiqué ci-dessus.
Dans la section Attribuer des rôles, recherchez et sélectionnez Agent de service Cloud Tasks
Cliquez sur Enregistrer.
Utiliser gcloud
Trouvez votre numéro de projet:
gcloud projects describe PROJECT_ID --format='table(projectNumber)'
Remplacez PROJECT_ID par l'ID du projet.
Copiez le numéro.
Attribuez le rôle
Cloud Tasks Service Agent
au compte de service Cloud Tasks en utilisant le numéro de projet que vous avez copié :gcloud projects add-iam-policy-binding PROJECT_ID --member serviceAccount:service-PROJECT_NUMBER@gcp-sa-cloudtasks.iam.gserviceaccount.com --role roles/cloudtasks.serviceAgent
Remplacez PROJECT_ID par l'ID de votre projet et PROJECT_NUMBER par le numéro de projet indiqué ci-dessus.
Configuration avancée
Vous pouvez configurer un certain nombre d'attributs dans votre tâche. Pour consultez la liste de tâches définition de ressource.
Exemples d'attributs personnalisables:
- Attribution de noms:si vous avez choisi de spécifier un nom pour le tâche, Cloud Tasks peut utiliser ce nom pour assurer la déduplication, bien que le traitement nécessaire pour cela puisse augmenter la latence.
- Planification:vous pouvez planifier une tâche ultérieurement. Uniquement compatibles
pour
CreateTask
(non compatible avecBufferTask
) - Nouvelle configuration:configurez le comportement des nouvelles tentatives pour une tâche si celle-ci
est défaillant. Compatible uniquement avec
CreateTask
(non compatible avecBufferTask
)
Étape suivante
- Apprenez-en plus sur les tâches HTTP Target dans la documentation de référence de l'API RPC.
- Apprenez-en plus sur les tâches HTTP Target dans la documentation de référence de l'API REST.