Utiliser l'API Cloud Billing Budget

Découvrez comment envoyer des requêtes simples à l'API Cloud Billing Budget.

Pour obtenir la liste complète des méthodes, consultez la documentation de référence sur l'API REST ou l'API RPC.

Avant de commencer

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

  1. Consultez la présentation de l'API Cloud Billing Budget.
  2. Consultez l'article Prérequis pour l'API Cloud Billing Budget.
  3. Effectuez la procédure de configuration.

Identifier votre ID de compte Cloud Billing

Pour chaque appel d'API Cloud Billing Budget, vous aurez besoin de votre ID de compte Cloud Billing.

  1. Accédez à la page Manage billing accounts (Gérer les comptes de facturation) de Google Cloud Console.
  2. Dans l'onglet My billing accounts (Mes comptes de facturation), vous trouverez la liste des comptes Cloud Billing par nom et par ID. Recherchez l'ID du compte de facturation du compte dans lequel vous allez gérer les budgets.

Capture d'écran de la page "Gérer la facturation" indiquant l'emplacement de votre ID de compte de facturation.

Concepts clés liés au budget

  • Un budget peut être appliqué à l'ensemble d'un compte de facturation ou limité (filtré) à l'aide de filtres de budget précis afin de surveiller des tranches de coûts spécifiques.
  • Un budget appliqué à l'ensemble d'un compte de facturation Cloud inclut les coûts de tous les projets Google Cloud payés par ce compte de facturation.
  • Vous pouvez affiner le champ d'application du budget à l'aide de filtres, tels qu'un sous-ensemble de projets et/ou de services, et/ou d'autres filtres de budget applicables à votre compte de facturation Cloud.
  • Vous pouvez spécifier la période correspondant au budget. Par défaut, un budget surveille les coûts engendrés au cours d'un mois calendaire. En utilisant le filtre usage_period disponible dans l'API Cloud Billing Budget, vous pouvez configurer la période du budget sur une configuration CalendarPeriod ou {101. }CustomPeriod, ce qui vous permet de créer des budgets afin de surveiller des périodes au-delà du mois calendaire par défaut, par exemple un trimestre, une année ou une plage de dates personnalisée que vous 10.1 préciser.
  • Vous pouvez définir le montant du budget sur un montant total que vous spécifiez, ou baser le montant du budget sur les dépenses de la période calendaire précédente.
  • Vous pouvez définir des règles fixant des seuils de budget pour déclencher des notifications d'alerte par e-mail. Lorsque vos coûts (coûts réels ou prévisions) dépassent un pourcentage de votre budget (en fonction des règles que vous avez définies), les e-mails d'alerte sont envoyés aux destinataires que vous spécifiez. s'affiche en haut de l'écran.
  • Vous pouvez définir les règles de notification du budget pour spécifier les destinataires des alertes et activer l'automatisation notifications via Pub/Sub.
  • Vous pouvez utiliser les sujets Pub/Sub pour les notifications automatisées, par exemple pour transférer vos messages budgétaires vers d'autres supports tels que Slack, ou pour automatiser les tâches de gestion des coûts).

Limite de quota: un seul compte Cloud Billing peut être associé à un maximum de 5 000 budgets à la fois. Pour en savoir plus, consultez la page Quotas et limites.

Appeler l'API

Les exemples suivants montrent comment envoyer des requêtes simples à l'API Cloud Billing Budget.

Répertorier les budgets

Cette méthode API répertorie tous les budgets disponibles pour un compte Cloud Billing donné.

API REST et ligne de commande

Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

  • billing-account-id: ID du compte Cloud Billing auquel les budgets s'appliquent.

Méthode HTTP et URL :

GET https://billingbudgets.googleapis.com/v1/billingAccounts/billing-account-id/budgets

Pour envoyer votre requête, développez l'une des options suivantes :

Vous devriez recevoir une réponse JSON de ce type :

{
  "budgets": [
   {
      "name": "billingAccounts/000000-111111-222222/budgets/33333333-4444-5555-6666-777777777777",
      "displayName": "Forecasted spend budget with Service Filter",
      "budgetFilter": {
        "projects": [
          "projects/123456789"
        ],
        "services": [
          "services/A1E8-BE35-7EBC"
        ],
        "creditTypesTreatment": "EXCLUDE_ALL_CREDITS",
        "calendarPeriod": "MONTH"
      },
      "amount": {
        "lastPeriodAmount": {}
      },
      "thresholdRules": [
        {
          "thresholdPercent": 0.9,
          "spendBasis": "FORECASTED_SPEND"
        }
      ],
      "allUpdatesRule": {},
      "etag": "c9d6c011f6fa6b5c"
    }
  ]
}

Obtenir le budget

Cette méthode API permet d'obtenir les détails d'un budget particulier.

API REST et ligne de commande

Pour appeler cette méthode, vous avez besoin du budget-id du budget que vous souhaitez mettre à jour. Vous pouvez obtenir l'ID du budget à partir de la sortie createBudget lorsque vous créez votre budget ou de la sortie listBudgets si vous répertoriez tous vos budgets.

Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

  • billing-account-id: ID du compte Cloud Billing auquel ce budget s'applique.
  • budget-id: ID du budget que vous souhaitez obtenir.

Méthode HTTP et URL :

GET https://billingbudgets.googleapis.com/v1/billingAccounts/billing-account-id/budgets/budget-id

Pour envoyer votre requête, développez l'une des options suivantes :

Vous devriez recevoir une réponse JSON de ce type :

{
  "name": "billingAccounts/000000-111111-222222/budgets/33333333-4444-5555-6666-777777777777",
  "displayName": "Forecasted spend budget with Service Filter",
  "budgetFilter": {
    "projects": [
      "projects/123456789"
    ],
    "services": [
      "services/A1E8-BE35-7EBC"
    ],
    "creditTypesTreatment": "EXCLUDE_ALL_CREDITS",
    "calendarPeriod": "MONTH"
  },
  "amount": {
    "lastPeriodAmount": {}
  },
  "thresholdRules": [
    {
      "thresholdPercent": 0.9,
      "spendBasis": "FORECASTED_SPEND"
    }
  ],
  "allUpdatesRule": {},
  "etag": "c9d6c011f6fa6b5c"
}

Créer un budget

Cette méthode API permet d'appliquer un budget Cloud Billing au compte Cloud Billing spécifié.

API REST et ligne de commande

Cet exemple montre comment créer un budget pour un compte Cloud Billing donné qui est limité (filtré) en fonction d'un projet Google Cloud que vous spécifiez et que vous définissez pour une période calendaire d'un trimestre.

Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

  • project-id: ID de projet Google Cloud que vous souhaitez définir comme champ d'application du budget (budgetFilter).
  • billing-account-id: ID du compte Cloud Billing auquel ce budget s'applique.

Méthode HTTP et URL :

POST https://billingbudgets.googleapis.com/v1/billingAccounts/billing-account-id/budgets

Corps JSON de la requête :

{
  "displayName": "Keep my spending down",
  "budgetFilter": {
    "projects": [
      "projects/project-id"
    ],
    "calendar_period": "QUARTER"
  },
  "amount": {
    "lastPeriodAmount": {}
  },
  "thresholdRules": {
    "thresholdPercent": 0.8,
    "spendBasis": "CURRENT_SPEND"
  }
}

Pour envoyer votre requête, développez l'une des options suivantes :

Vous devriez recevoir une réponse JSON de ce type :

{
  "name": "billingAccounts/000000-111111-222222/budgets/33333333-4444-5555-6666-777777777777",
  "displayName": "Keep my spending down",
  "budgetFilter": {
    "projects": [
      "projects/123456789"
    ],
    "creditTypesTreatment": "INCLUDE_ALL_CREDITS",
    "calendar_period": "QUARTER"
  },
  "amount": {
    "lastPeriodAmount": {}
  },
  "thresholdRules": {
    "thresholdPercent": 0.8,
    "spendBasis": "CURRENT_SPEND"
  },
  "allUpdatesRule": {},
  "etag": "f7928d8010160668"
}

Mettre à jour un budget

Cette méthode API permet de modifier un budget Cloud Billing existant afin de modifier le montant du budget, les filtres de budget (champ d'application du budget), à la période budgétaire ou aux règles de seuil.

API REST et ligne de commande

Cet exemple montre comment mettre à jour un budget existant pour définir un champ d'application (filtre) en fonction d'un projet Google Cloud que vous spécifiez et pour mettre à jour la période associée au budget à partir d'un mois. à un budget trimestriel.

Pour appeler cette méthode, vous avez besoin du budget-id du budget que vous souhaitez mettre à jour. Vous pouvez obtenir l'ID du budget à partir de la sortie createBudget lorsque vous créez votre budget ou de la sortie listBudgets si vous répertoriez tous vos budgets.

Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

  • project-id: ID de projet Google Cloud que vous souhaitez définir comme champ d'application du budget (budgetFilter).
  • billing-account-id: ID du compte Cloud Billing auquel ce budget s'applique.
  • budget-id: ID du budget que vous souhaitez mettre à jour.

Méthode HTTP et URL :

PATCH https://billingbudgets.googleapis.com/v1/billingAccounts/billing-account-id/budgets/budget-id

Corps JSON de la requête :

{
  "budget": {
    "displayName": "My fancy budget",
    "budgetFilter": {
      "projects": [
        "projects/project-id"
      ],
      "calendar_period": "QUARTER"
    },
   "amount": {
      "specifiedAmount": {
        "units": 500
      }
    },
    "thresholdRules": {
      "thresholdPercent": 0.8,
      "spendBasis": "CURRENT_SPEND"
    }
  }
}

Pour envoyer votre requête, développez l'une des options suivantes :

Vous devriez recevoir une réponse JSON de ce type :

{
  "name": "billingAccounts/000000-111111-222222/budgets/33333333-4444-5555-6666-777777777777",
  "displayName": "My fancy budget",
  "budgetFilter": {
    "projects": [
      "projects/123456789"
    ],
    "creditTypesTreatment": "INCLUDE_ALL_CREDITS",
    "calendar_period": "QUARTER"
  },
  "amount": {
    "specifiedAmount": {
      "units": 500
    }
  },
  "thresholdRules": {
    "thresholdPercent": 0.8,
    "spendBasis": "CURRENT_SPEND"
  },
  "allUpdatesRule": {},
  "etag": "f7928d8010160668"
}

Supprimer un budget

Cette méthode API permet de supprimer un budget Cloud Billing existant.

API REST et ligne de commande

Pour appeler cette méthode, vous avez besoin du budget-id du budget que vous souhaitez mettre à jour. Vous pouvez obtenir l'ID du budget à partir de la sortie createBudget lorsque vous créez votre budget ou de la sortie listBudgets si vous répertoriez tous vos budgets.

Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

  • billing-account-id: ID du compte Cloud Billing auquel ce budget s'applique.
  • budget-id: ID du budget que vous souhaitez supprimer.

Méthode HTTP et URL :

DELETE https://billingbudgets.googleapis.com/v1/billingAccounts/billing-account-id/budgets/budget-id

Pour envoyer votre requête, développez l'une des options suivantes :

Vous devriez recevoir une réponse JSON de ce type :

{}