Utilizzo dell'API Cloud Billing Budget

Scopri come inviare alcune semplici richieste all'API Cloud Billing Budget.

Per un elenco completo dei metodi, consulta la documentazione di riferimento dell'API REST o dell'API RPC.

Prima di iniziare

Prima di leggere questa guida, devi:

  1. Leggi la panoramica dell'API Cloud Billing Budget.
  2. Leggi i prerequisiti dell'API Cloud Billing Budget.
  3. Esegui i passaggi di configurazione.

Identifica l'ID account di fatturazione Cloud

Per ogni chiamata all'API Cloud Billing Budget, ti servirà il tuo ID account di fatturazione Cloud.

  1. Vai alla pagina Pagina Gestisci account di fatturazione della console Google Cloud.
  2. Nella scheda I miei account di fatturazione, vedrai l'elenco di Account di fatturazione Cloud per nome e ID. Individua il ID account di fatturazione per l'account in cui gestirai i budget.

Screenshot della pagina Gestisci la fatturazione che mostra la posizione dell'ID account di fatturazione.

Concetti chiave del budget

  • Un budget può essere applicato a un intero account di fatturazione o limitato (filtrato) utilizzando filtri granulari per monitorare sezioni specifiche dei costi.
  • Un budget applicato a un intero account di fatturazione Cloud include i costi di tutti i progetti Google Cloud pagati da quell'account di fatturazione.
  • Se l'accesso all'account di fatturazione Cloud è limitato o nullo, puoi creare budget per singoli progetti per i progetti di tua proprietà. Se sei un Utente a livello di account di fatturazione Cloud, puoi creare un progetto singolo I budget che non possono essere modificati dagli utenti a livello di progetto utilizzando OwnershipScope nel campo del budget.
  • Puoi restringere l'ambito del budget utilizzando i filtri, ad esempio un sottoinsieme di organizzazioni, cartelle, progetti, servizi e altri filtri del budget applicabili al tuo account di fatturazione Cloud.
  • Puoi specificare il periodo di tempo del budget. Per impostazione predefinita, un budget monitora i costi sostenuti durante un mese di calendario. Utilizzo del filtro usage_period che è disponibile nell'API Cloud Billing Budget, puoi configurare il budget in un periodo di tempo di CalendarPeriod o un CustomPeriod, consentendoti di creare budget per monitorare gli intervalli di tempo oltre quelli predefiniti mese di calendario, ad esempio un trimestre, un anno o un intervallo di date specificare.
  • Puoi impostare l'importo del budget su un totale da te specificato o basarlo sulla spesa del periodo di calendario precedente.
  • Puoi impostare regole per le soglie di budget per attivare le notifiche di avviso via email. Quando i costi (effettivi o previsti) superano una percentuale del budget (in base alle regole impostate), vengono inviate email di avviso ai destinatari specificati.
  • Puoi impostare il valore regole di notifica, per specificare i destinatari dell'email di avvisi relativi al budget e per abilitare notifiche programmatiche tramite Pub/Sub.
  • Puoi utilizzare gli argomenti Pub/Sub per le notifiche programmatiche (ad esempio, per inoltrare i messaggi relativi al budget ad altri mezzi come Slack o per automatizzare le attività di gestione dei costi).

Limite di quota: ogni singolo account di fatturazione Cloud può avere diverse migliaia di budget associate alla volta. Per i limiti attuali e ulteriori informazioni, consulta Quote e limiti.

Chiamata all'API

I seguenti esempi mostrano come inviare alcune semplici richieste ai l'API Cloud Billing Budget.

Elenco budget

Questo metodo API elenca tutti i budget disponibili per un determinato account Cloud Billing.

REST

Prima di utilizzare i dati della richiesta, apporta le seguenti sostituzioni:

  • billing-account-id: l'ID account di fatturazione Cloud e i budget si applicano.
  • project-id: il progetto Google Cloud in cui è abilitata l'API Cloud Billing Budget.

Metodo HTTP e URL:

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

Per inviare la richiesta, espandi una di queste opzioni:

Dovresti ricevere una risposta JSON simile alla seguente:

{
  "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"
    }
  ]
}

Ottieni il budget

Questo metodo dell'API recupera i dettagli di un determinato budget.

REST

Per chiamare questo metodo, devi disporre del budget-id del budget che vuoi aggiornare. Puoi ottenere l'ID budget dall'output createBudget quando crei il budget o dall'output listBudgets se elenchi tutti i budget.

Prima di utilizzare i dati della richiesta, apporta le seguenti sostituzioni:

  • billing-account-id: l'ID account di fatturazione Cloud di questo budget a cui si applica.
  • budget-id: l'ID del budget che vuoi ottenere.
  • project-id: il progetto Google Cloud in cui è attivata l'API Budget della fatturazione Cloud.

Metodo HTTP e URL:

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

Per inviare la richiesta, espandi una di queste opzioni:

Dovresti ricevere una risposta JSON simile alla seguente:

{
  "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"
}

Crea budget

Questo metodo dell'API crea un budget di fatturazione Cloud applicato all'account di fatturazione Cloud specificato.

REST

Questo esempio mostra come creare un budget per un determinato account di fatturazione Cloud ovvero con ambito (filtrato) da un progetto Google Cloud da te specificato e impostato per un di un periodo di tempo di calendario di un trimestre.

Prima di utilizzare i dati della richiesta, apporta le seguenti sostituzioni:

  • projects/budget-scope-project-id: l'ID progetto Google Cloud che vuoi impostare come ambito del budget (budgetFilter).
  • billing-account-id: l'ID account Cloud Billing a cui si applica questo budget.
  • api-user-project-id: il progetto Google Cloud in cui è attivata l'API Budget della fatturazione Cloud.

Metodo HTTP e URL:

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

Corpo JSON della richiesta:

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

Per inviare la richiesta, espandi una delle seguenti opzioni:

Dovresti ricevere una risposta JSON simile alla seguente:

{
  "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"
}

Aggiornare il budget

Utilizza questo metodo API per modificare un budget di fatturazione cloud esistente per cambiare il importo del budget, i filtri del budget (ambito del budget), il periodo di tempo del budget o le regole di soglia.

REST

Questo esempio mostra come aggiornare un budget esistente per impostare ambito (filtro) da un progetto Google Cloud da te specificato e per aggiorna il periodo di tempo del budget da mensile a trimestrale .

Per chiamare questo metodo, devi disporre del budget-id del budget che vuoi aggiornare. Puoi ottenere l'ID budget dall'output createBudget quando crei il budget o dall'output listBudgets se elenchi tutti i budget.

Prima di utilizzare i dati della richiesta, apporta le seguenti sostituzioni:

  • projects/budget-scope-project-id: il progetto Google Cloud I che vuoi impostare come ambito del budget (budgetFilter).
  • billing-account-id: l'ID account di fatturazione Cloud di questo budget a cui si applica.
  • budget-id: l'ID del budget da aggiornare.
  • api-user-project-id: il progetto Google Cloud in cui è attivata l'API Budget della fatturazione Cloud.

Metodo HTTP e URL:

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

Corpo JSON della richiesta:

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

Per inviare la richiesta, espandi una delle seguenti opzioni:

Dovresti ricevere una risposta JSON simile alla seguente:

{
  "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"
}

Eliminare un budget

Utilizza questo metodo API per eliminare budget di fatturazione Cloud esistente.

REST

Per chiamare questo metodo, devi disporre del budget-id del budget che vuoi aggiornare. Puoi ottenere l'ID budget dall'output createBudget quando crei il budget o dall'output listBudgets se elenchi tutti i budget.

Prima di utilizzare i dati della richiesta, apporta le seguenti sostituzioni:

  • billing-account-id: l'ID account Cloud Billing a cui si applica questo bilancio.
  • budget-id: l'ID del budget da eliminare.
  • project-id: il progetto Google Cloud in cui è attivata l'API Budget della fatturazione Cloud.

Metodo HTTP e URL:

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

Per inviare la richiesta, espandi una di queste opzioni:

Dovresti ricevere una risposta JSON simile alla seguente:

{}