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 sull'API REST o sull'API RPC.

Prima di iniziare

Prima di leggere questa guida, segui questi passaggi:

Leggi la panoramica dell'API Cloud Billing Budget.
Leggi i prerequisiti dell'API Cloud Billing Budget.
Esegui la procedura di configurazione.

Identifica il tuo ID account di fatturazione Cloud

Per ogni chiamata all'API Cloud Billing Budget, devi avere il tuo ID account Cloud Billing.

Vai alla pagina Gestisci account di fatturazione della console Google Cloud.
Nella scheda I miei account di fatturazione vedrai l'elenco degli account di fatturazione Cloud per nome e ID. Individua l'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 di budget

Un budget può essere applicato a un intero account di fatturazione o ambito (filtrato) utilizzando filtri di budget granulari per monitorare sezioni specifiche dei tuoi 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 hai accesso limitato o nullo all'account di fatturazione Cloud, 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 budget per un singolo progetto che non possono essere modificati dagli utenti a livello di progetto utilizzando il campo OwnershipScope nel budget.
Puoi restringere l'ambito del budget utilizzando i filtri, ad esempio un sottoinsieme di organizzazioni, cartelle, progetti, servizi e altri filtri di 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. Utilizzando il filtro usage_period disponibile nell'API Cloud Billing Budget, puoi configurare il periodo di tempo del budget su CalendarPeriod o CustomPeriod, in modo da creare budget per monitorare gli intervalli di tempo oltre il mese di calendario predefinito, ad esempio un trimestre, un anno o un intervallo di date personalizzato da te specificato.
Puoi impostare l'importo del budget su un totale da te specificato oppure puoi basare l'importo del budget sulla spesa del periodo di calendario precedente.
Puoi impostare regole di soglia di budget per attivare notifiche di avviso via email. Quando i costi (costi effettivi o previsti) superano una percentuale del budget (in base alle regole impostate), vengono inviate email di avviso ai destinatari specificati.
Puoi impostare le regole di notifica del budget per specificare i destinatari email degli avvisi relativi al budget e attivare le notifiche programmatiche utilizzando Pub/Sub.
Puoi utilizzare gli argomenti Pub/Sub per le notifiche programmatiche (ad esempio per inoltrare messaggi relativi al budget ad altri mezzi come Slack o automatizzare le attività di gestione dei costi).

Limitazione della quota: a ogni singolo account di fatturazione Cloud può essere associato diverse migliaia di budget alla volta. Consulta Quote e limiti per i limiti attuali e informazioni aggiuntive.

Chiamata all'API

Gli esempi riportati di seguito mostrano come inviare alcune semplici richieste all'API Cloud Billing Budget.

Elenco budget

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

REST

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

billing-account-id: l'ID account di fatturazione Cloud a cui si applicano i budget.
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:

curl (Linux, macOS o Cloud Shell)

Nota: il comando seguente presuppone che tu abbia eseguito l'accesso all'interfaccia a riga di comando gcloud con il tuo account utente eseguendo gcloud init o gcloud auth login oppure utilizzando Cloud Shell, che ti consente di accedere automaticamente all'interfaccia a riga di comando di gcloud. . Puoi controllare l'account attualmente attivo eseguendo gcloud auth list.

Esegui questo comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "x-goog-user-project: project-id" \
     "https://billingbudgets.googleapis.com/v1/billingAccounts/billing-account-id/budgets"

PowerShell (Windows)

Esegui questo comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred"; "x-goog-user-project" = "project-id" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://billingbudgets.googleapis.com/v1/billingAccounts/billing-account-id/budgets" | Select-Object -Expand Content

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 budget

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

REST

Per chiamare questo metodo, è necessario il budget-id del budget da aggiornare. Puoi ottenere l'ID budget dall'output createBudget quando crei il budget oppure dall'output listBudgets se elenchi tutti i budget.

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

billing-account-id: l'ID account di fatturazione Cloud a cui si applica questo budget.
budget-id: l'ID del budget da ottenere.
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/budget-id

Per inviare la richiesta, espandi una di queste opzioni:

curl (Linux, macOS o Cloud Shell)

Esegui questo comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "x-goog-user-project: project-id" \
     "https://billingbudgets.googleapis.com/v1/billingAccounts/billing-account-id/budgets/budget-id"

PowerShell (Windows)

Esegui questo comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred"; "x-goog-user-project" = "project-id" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://billingbudgets.googleapis.com/v1/billingAccounts/billing-account-id/budgets/budget-id" | Select-Object -Expand Content

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 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 con ambito (filtrato) da un progetto Google Cloud specificato e impostato per un periodo di tempo nel calendario di un trimestre.

Prima di utilizzare i dati della richiesta, effettua 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 di fatturazione Cloud a cui si applica questo budget.
api-user-project-id: il progetto Google Cloud in cui è abilitata l'API Cloud Billing Budget.

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 di queste opzioni:

curl (Linux, macOS o Cloud Shell)

Salva il corpo della richiesta in un file denominato request.json ed esegui questo comando:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "x-goog-user-project: api-user-project-id" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://billingbudgets.googleapis.com/v1/billingAccounts/billing-account-id/budgets"

PowerShell (Windows)

Salva il corpo della richiesta in un file denominato request.json ed esegui questo comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred"; "x-goog-user-project" = "api-user-project-id" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://billingbudgets.googleapis.com/v1/billingAccounts/billing-account-id/budgets" | Select-Object -Expand Content

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 al fine di cambiare l'importo del budget, i filtri budget (ambito budget), il periodo di tempo del budget o le regole di soglia.

REST

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

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

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

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 di queste opzioni:

curl (Linux, macOS o Cloud Shell)

Salva il corpo della richiesta in un file denominato request.json ed esegui questo comando:

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "x-goog-user-project: api-user-project-id" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://billingbudgets.googleapis.com/v1/billingAccounts/billing-account-id/budgets/budget-id"

PowerShell (Windows)

Salva il corpo della richiesta in un file denominato request.json ed esegui questo comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred"; "x-goog-user-project" = "api-user-project-id" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://billingbudgets.googleapis.com/v1/billingAccounts/billing-account-id/budgets/budget-id" | Select-Object -Expand Content

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 un budget di fatturazione Cloud esistente.

REST

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

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

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:

curl (Linux, macOS o Cloud Shell)

Esegui questo comando:

curl -X DELETE \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "x-goog-user-project: project-id" \
     "https://billingbudgets.googleapis.com/v1/billingAccounts/billing-account-id/budgets/budget-id"

PowerShell (Windows)

Esegui questo comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred"; "x-goog-user-project" = "project-id" }

Invoke-WebRequest `
    -Method DELETE `
    -Headers $headers `
    -Uri "https://billingbudgets.googleapis.com/v1/billingAccounts/billing-account-id/budgets/budget-id" | Select-Object -Expand Content

Dovresti ricevere una risposta JSON simile alla seguente:

{}

Indietro

Configurazione