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 section Présentation de l'API Cloud Billing Budget.
  2. Consultez la section Conditions préalables à l'utilisation de l'API Cloud Billing Budget.
  3. Effectuez la procédure de configuration.

Identifier votre ID de compte de facturation

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

  1. Accédez à la page Manage billing accounts (Gérer les comptes de facturation) de Google Cloud Console.
  2. À partir de l'onglet My billing accounts (Mes comptes de facturation), vous trouverez la liste des comptes de facturation par nom et par ID. Recherchez le paramètre Billing account ID (ID du compte de facturation) associé au compte pour lequel vous gérez les budgets.

Capture d'écran de la page Manage billing accounts (Gérer les comptes de facturation) indiquant l'emplacement de l'ID de compte de facturation.

Appeler l'API

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

Un budget peut être appliqué à l'ensemble d'un compte de facturation ou limité (filtré) à un sous-ensemble de projets et/ou de produits utilisant des filtres de budget précis pour surveiller des tranches de coûts spécifiques entre des groupes de projets et de services.

Répertorier les budgets

Cette méthode API permet de répertorier tous les budgets définis 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 de facturation Google Cloud auquel les budgets s'appliquent.

Méthode HTTP et URL :

GET https://billingbudgets.googleapis.com/v1beta1/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 Svc Filter",
      "budgetFilter": {
        "projects": [
          "projects/123456789"
        ],
        "services": [
          "services/A1E8-BE35-7EBC"
        ],
        "creditTypesTreatment": "EXCLUDE_ALL_CREDITS"
      },
      "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 : numéro du compte de facturation Google Cloud auquel ce budget s'applique.
  • budget-id : ID du budget que vous souhaitez obtenir.

Méthode HTTP et URL :

GET https://billingbudgets.googleapis.com/v1beta1/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 Svc Filter",
  "budgetFilter": {
    "projects": [
      "projects/123456789"
    ],
    "services": [
      "services/A1E8-BE35-7EBC"
    ],
    "creditTypesTreatment": "EXCLUDE_ALL_CREDITS"
  },
  "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 de facturation donné qui est limité (filtré) en fonction d'un projet Google Cloud que vous spécifiez.

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

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

Méthode HTTP et URL :

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

Corps JSON de la requête :

{
  "budget": {
    "displayName": "Keep my spending down",
    "budgetFilter": {
      "projects": [
        "projects/project-id"
      ]
    },
    "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"
  },
  "amount": {
    "lastPeriodAmount": {}
  },
  "thresholdRules": {
    "thresholdPercent": 0.8,
    "spendBasis": "CURRENT_SPEND"
  },
  "allUpdatesRule": {},
  "etag": "f7928d8010160668"
}

Mettre à jour un budget

Cette méthode API permet de mettre à jour un budget Cloud Billing existant afin de modifier le montant du budget, les filtres (champ d'application du budget) ou les seuils d'alerte.

API REST et ligne de commande

Cet exemple montre comment mettre à jour un budget existant et définir un champ d'application (filtre) en fonction d'un projet Google Cloud que vous spécifiez.

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 du projet Google Cloud que vous souhaitez définir en tant que champ d'application du budget (budgetFilter).
  • billing-account-id : numéro du compte de facturation Google Cloud 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/v1beta1/billingAccounts/billing-account-id/budgets/budget-id

Corps JSON de la requête :

{
  "budget": {
    "displayName": "My fancy budget",
    "budgetFilter": {
      "projects": [
        "projects/project-id"
      ]
    },
   "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"
  },
  "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 : numéro du compte de facturation Google Cloud auquel ce budget s'applique.
  • budget-id : ID du budget que vous souhaitez supprimer.

Méthode HTTP et URL :

DELETE https://billingbudgets.googleapis.com/v1beta1/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 :

{}