Configuration de l'API Cloud Billing Budget

Ce guide fournit toutes les étapes de configuration requises pour commencer à utiliser l'API Cloud Billing Budget.

Avant de commencer

Avant de lire ce guide, procédez comme suit :

  1. Consultez la section Présentation de l'API Cloud Billing Budget.
  2. Consultez la section Conditions préalables à l'utilisation de l'API Cloud Billing Budget.

À propos de Cloud Console

Google Cloud Console (Accéder à la documentation, Ouvrir la console) est une interface utilisateur Web permettant de provisionner, configurer, gérer et surveiller les systèmes utilisant des produits Google Cloud. Vous utilisez Cloud Console pour configurer et gérer les ressources Google Cloud et Cloud Billing.

1. Sélectionner ou créer un projet

Pour utiliser les services fournis par Google Cloud, vous devez créer un projet. Un projet permet d'organiser toutes vos ressources Google Cloud. Il se compose d'un ensemble de collaborateurs, d'API activées (et d'autres ressources), d'outils de surveillance, d'informations de facturation, et de contrôles d'authentification et d'accès. Vous pouvez créer un projet, ou en créer plusieurs et les utiliser pour organiser vos ressources Google Cloud dans une hiérarchie des ressources. Pour en savoir plus sur les projets, consultez la documentation concernant Resource Manager.

Recommandation : Nous vous recommandons de configurer un seul projet Google Cloud distinct pour gérer vos exigences d'administration de la facturation, y compris l'API Cloud Billing Budget. Votre projet Google Cloud d'administration de la facturation peut également être utilisé pour l'accès à l'API Cloud Billing Account, aux données exportées Cloud Billing, aux canaux Pub/Sub pour les notifications de budget automatisées, etc.

Dans Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Cloud.

Accéder à la page de sélection du projet

2. Activer la facturation

Vous devez vous assurer que la facturation est activée sur le projet que vous utilisez pour appeler l'API Cloud Billing Budget. Si vous avez suivi la recommandation dans la section Sélectionner ou créer un projet, il s'agit de votre projet d'administration de la facturation Google Cloud.

Un compte Cloud Billing sert à déterminer qui assume les frais pour un ensemble donné de ressources Google Cloud. Les ressources, telles que les API activées, sont organisées dans des projets. Un compte Cloud Billing peut être associé à un ou plusieurs projets. Les frais d'utilisation du projet sont imputés au compte de facturation associé. Dans la plupart des cas, vous configurez la facturation lorsque vous créez un projet. Pour en savoir plus, consultez la documentation concernant la facturation.

Vous configurez des budgets Cloud Billing pour surveiller un compte Cloud Billing. Le compte Cloud Billing que vous surveillez peut être le même que le compte Cloud Billing associé au projet que vous utilisez pour appeler l'API Cloud Billing Budget. Notez que l'API Cloud Billing Budget est gratuite pour les clients Google Cloud. Si vous choisissez de configurer des notifications de budget automatisées, les tarifs Pub/Sub standards vous seront facturés.

Vérifiez que la facturation est activée pour votre projet Google Cloud. Découvrez comment vérifier que la facturation est activée pour votre projet.

3. Activer l'API

Vous devez activer l'API Cloud Billing Budget dans le projet que vous utilisez pour appeler l'API Cloud Billing Budget. Si vous avez suivi la recommandation dans la section Sélectionner ou créer un projet, il s'agit de votre projet d'administration de la facturation Google Cloud.

Pour en savoir plus sur l'activation des API, consultez la documentation concernant Service Usage.

Activez Cloud Billing Budget API.

Activer l'API

4. Configurer l'authentification

Si vous prévoyez d'utiliser l'API Cloud Billing Budget, vous devez configurer l'authentification. Toute application cliente qui utilise l'API doit être authentifiée et se voir accorder l'accès aux ressources demandées. Cette section décrit des concepts d'authentification importants et vous indique la procédure à suivre pour la configurer. Pour en savoir plus, consultez la Présentation de l'authentification dans GCP.

À propos des comptes de service

Il existe plusieurs options d'authentification, mais nous vous recommandons d'utiliser les comptes de service pour l'authentification et le contrôle des accès. Un compte de service fournit des identifiants pour les applications, et non pour les utilisateurs finaux.

Les comptes de service appartiennent à des projets. Vous pouvez créer plusieurs comptes de service par projet. Pour en savoir plus, consultez la page Comptes de service.

À propos des rôles

Lorsqu'une identité (le compte de service) appelle une API, Google Cloud exige que cette identité dispose des autorisations appropriées. Vous accordez des autorisations en attribuant des rôles à un compte de service. Pour en savoir plus, consultez la documentation de Cloud IAM (Cloud Identity and Access Management).

Pour utiliser toutes les méthodes de l'API Cloud Billing Budget, vous devez ajouter le compte de service en tant que membre à chaque compte Cloud Billing sur lequel vous souhaitez utiliser l'API Cloud Billing Budget pour gérer les budgets de manière automatisée et attribuer les rôles appropriés au compte de service.

Si vous prévoyez de configurer un sujet Pub/Sub pour les notifications de budget automatisées, vous devez également ajouter le compte de service en tant que membre du projet où votre sujet Pub/Sub réside et attribuer le rôle Administrateur de sécurité Cloud IAM au compte de service. Ce rôle est nécessaire pour permettre au compte de service d'accorder le rôle Éditeur Pub/Sub sur le sujet afin que Cloud Billing puisse y publier des messages.

Pour plus d'informations sur les rôles spécifiques aux API Cloud Billing, consultez la documentation sur le contrôle des accès dans les API Cloud Billing.

À propos des clés de compte de service

Les comptes de service sont associés à une ou plusieurs paires de clés publiques/privées. Lorsque vous créez une paire de clés, vous téléchargez la clé privée. Cette clé privée permet de générer des identifiants lors de l'appel de l'API. Vous êtes responsable de la sécurité de la clé privée et des autres opérations de gestion, telles que la rotation des clés.

A. Créer un compte de service et télécharger le fichier de clé privée

Le compte de service doit être créé dans le même projet que celui où vous avez enregistré l'API Cloud Billing Budget. Si vous avez suivi la recommandation dans la section Sélectionner ou créer un projet, il s'agit de votre projet d'administration de la facturation Google Cloud.

  1. Dans Cloud Console, accédez à la page Créer une clé de compte de service.

    Accéder à la page Créer une clé de compte de service
  2. Dans la liste Compte de service, sélectionnez Nouveau compte de service.
  3. Dans le champ Nom du compte de service, saisissez un nom.
  4. Ne sélectionnez pas de valeur dans la liste Rôle (ce compte de service ne gère pas les ressources du projet). Lors d'une prochaine étape, vous accorderez au compte de service les autorisations nécessaires pour gérer les budgets de votre compte Cloud Billing.
  5. Cliquez sur Créer. Une note s'affiche pour signaler que ce compte de service n'est associé à aucun rôle.
  6. Cliquez sur Créer sans rôle. Un fichier JSON contenant votre clé est téléchargé sur votre ordinateur.

B. Accorder les autorisations à votre compte de service pour utiliser l'API Cloud Billing Budget

Accordez les rôles Cloud Billing et Cloud IAM à votre compte de service pour lui attribuer les autorisations nécessaires pour utiliser toutes les méthodes de l'API Cloud Billing Budget sur tous les budgets de votre compte Cloud Billing.

  1. Recherchez l'adresse e-mail de votre compte de service dans le fichier json que vous venez de télécharger à l'aide de la clé client_email. L'adresse e-mail doit ressembler à service-account-name@project-id.iam.gserviceaccount.com.
  2. Dans Cloud Console, accédez à la page de gestion du compte Cloud Billing et suivez les instructions ci-dessous pour mettre à jour les autorisations de facturation du compte de service.
  3. Facultatif : Si vous prévoyez de configurer vos budgets avec des notifications de budget automatisées, vous devez également attribuer des autorisations IAM au projet où votre sujet Pub/Sub réside (cela peut être votre projet d'administration de la facturation Google Cloud si vous avez suivi la recommandation dans la section Sélectionner ou créer un projet).
    1. Ouvrez le menu de navigation de la console (), puis cliquez sur IAM et administration > IAM.
    2. Dans l'onglet Autorisations IAM, vérifiez que vous pouvez afficher les autorisations associées au projet dans lequel se trouve votre sujet Pub/Sub. Un titre semblable à celui-ci s'affiche sur la page : Autorisations pour le projet "Mon projet d'administration Cloud Billing".
    3. Ajoutez l'adresse e-mail du compte de service en tant que membre du projet et attribuez le rôle Administrateur de sécurité Cloud  IAM au membre du compte de service.
      1. Cliquez sur Ajouter.
      2. Dans le champ Nouveaux membres, saisissez l'adresse e-mail du compte de service.
      3. Dans la liste déroulante Sélectionner un rôle, faites défiler la page jusqu'à (ou filtrez par) IAM, puis sélectionnez le rôle Administrateur de sécurité.

C. Utiliser le fichier de clé de compte de service dans votre environnement

Fournissez des identifiants d'authentification au code de votre application en définissant la variable d'environnement GOOGLE_APPLICATION_CREDENTIALS. Remplacez [PATH] par le chemin du fichier JSON contenant la clé de votre compte de service. Cette variable ne s'applique qu'à la session d'interface système actuelle. Par conséquent, si vous ouvrez une nouvelle session, vous devez la définir à nouveau.

Linux ou macOS

export GOOGLE_APPLICATION_CREDENTIALS="[PATH]"

Exemple :

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/my-key.json"

Windows

Avec PowerShell :

$env:GOOGLE_APPLICATION_CREDENTIALS="[PATH]"

Exemple :

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\my-key.json"

Avec l'invite de commande :

set GOOGLE_APPLICATION_CREDENTIALS=[PATH]

5. Installer et initialiser le SDK Cloud

Si vous prévoyez d'utiliser l'API Cloud Billing Budget, vous devez installer et initialiser le SDK Cloud. Le SDK Cloud est un ensemble d'outils qui vous permet de gérer les ressources et les applications hébergées sur Google Cloud. Cela inclut l'outil de ligne de commande gcloud. Le lien suivant fournit les instructions correspondantes :

Installez et initialisez le SDK Cloud.

6. Tester le SDK et s'authentifier

Si vous avez configuré l'authentification lors des étapes précédentes, vous pouvez utiliser l'outil gcloud pour tester votre environnement d'authentification. Exécutez la commande suivante pour vérifier qu'aucune erreur ne se produit et que les identifiants sont bien renvoyés :

gcloud auth application-default print-access-token

Cette commande est utilisée par tous les exemples REST en ligne de commande de l'API Cloud Billing Budget afin d'authentifier les appels d'API.

7. Installer la bibliothèque cliente de l'API Cloud Billing Budget

L'API Cloud Billing Budget est basée sur HTTP et JSON. Par conséquent, n'importe quel client HTTP standard peut lui envoyer des requêtes et analyser ses réponses.

Vous disposez des trois options suivantes pour appeler l'API :

  • Bibliothèques clientes compatibles avec Google (recommandé)

    Les bibliothèques clientes permettent d'intégrer plus facilement les langages de programmation, d'améliorer la sécurité et d'accepter les appels nécessitant des privilèges utilisateur. Les bibliothèques clientes compatibles avec Google sont disponibles dans plusieurs langages courants, et sont l'option recommandée.

  • REST

  • gRPC