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

Prima di iniziare

Prima di leggere questa guida, devi eseguire le seguenti operazioni:

  1. Leggi l'articolo sulla panoramica dell'API Cloud Billing Budget.
  2. Leggi i prerequisiti dell'API Cloud Billing Budget.
  3. Esegui la procedura di configurazione.

Identifica il tuo ID account di fatturazione Cloud

Per ogni chiamata all'API Cloud Billing Budget, è necessario l'ID account di fatturazione Cloud.

  1. Vai alla pagina Gestisci account di fatturazione Google Cloud Console.
  2. 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 fatturazione che mostra la posizione dell'ID account di fatturazione.

Concetti chiave relativi al budget

  • Puoi applicare un budget a un intero account di fatturazione o a un ambito (filtrato) utilizzando filtri di budget granulari per monitorare sezioni specifiche dei costi.
  • Un budget applicato a un intero account di fatturazione Cloud include i costi di tutti i progetti di Google Cloud pagati da quell'account di fatturazione.
  • Puoi restringere l'ambito del budget utilizzando i filtri, ad esempio un sottoinsieme di progetti e/o servizi e/o 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. Se utilizzi il filtro usage_period disponibile nell'API Cloud Billing Budget, puoi configurare il periodo di tempo del budget su un elemento 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 o basare l'importo del budget sulla spesa del periodo di calendario precedente.
  • Puoi impostare regole di soglia del budget per attivare le notifiche di avviso via email. Quando i costi (costi effettivi o costi previsti) superano una percentuale del budget (in base alle regole impostate), le email di avviso vengono inviate ai destinatari specificati.
  • Puoi impostare le regole di notifica del budget per specificare i destinatari delle email degli avvisi relativi al budget e attivare le notifiche programmatiche tramite Pub/Sub.
  • Puoi utilizzare gli argomenti Pub/Sub per le notifiche programmatiche (ad esempio per inoltrare i tuoi messaggi budget ad altri mezzi, come Slack, o per automatizzare le attività di gestione dei costi).

Limitazione di quota: a un singolo account di fatturazione Cloud possono essere associati fino a 5000 budget alla volta. Vedi Quote e limiti per ulteriori informazioni.

Chiamata all'API

I seguenti esempi 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 &CMD LINE

Prima di utilizzare uno qualsiasi dei dati della richiesta, effettua le seguenti sostituzioni:

  • billing-account-id: l'ID account di fatturazione Cloud a cui si applicano i budget.

Metodo HTTP e URL:

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

Per inviare la richiesta, espandi una delle seguenti 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 budget

Questo metodo API fornisce i dettagli per un determinato budget.

REST &CMD LINE

Per chiamare questo metodo, devi disporre di una percentuale pari a budget-id del budget che vuoi aggiornare. Puoi recuperare l'ID budget dall'output di createBudget quando crei il budget o da listBudgets se specifichi tutti i budget.

Prima di utilizzare uno qualsiasi dei 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 che vuoi ottenere.

Metodo HTTP e URL:

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

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": "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 &CMD LINE

Questo esempio mostra come creare un budget per un determinato account di fatturazione Cloud che ha un ambito (filtrato) da un progetto Google Cloud che specifichi e imposti per un periodo di tempo di calendario.

Prima di utilizzare uno qualsiasi dei dati della richiesta, effettua le seguenti sostituzioni:

  • project-id: l'ID progetto di 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.

Metodo HTTP e URL:

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

Corpo JSON richiesta:

{
  "displayName": "Keep my spending down",
  "budgetFilter": {
    "projects": [
      "projects/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 l'importo del budget, i filtri del budget (ambito budget), il periodo di tempo del budget o le regole di soglia.

REST &CMD LINE

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

Per chiamare questo metodo, devi disporre di una percentuale pari a budget-id del budget che vuoi aggiornare. Puoi recuperare l'ID budget dall'output di createBudget quando crei il budget o da listBudgets se specifichi tutti i budget.

Prima di utilizzare uno qualsiasi dei dati della richiesta, effettua le seguenti sostituzioni:

  • project-id: l'ID progetto di 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.

Metodo HTTP e URL:

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

Corpo JSON richiesta:

{
  "budget": {
    "displayName": "My fancy budget",
    "budgetFilter": {
      "projects": [
        "projects/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 un budget di fatturazione Cloud esistente.

REST &CMD LINE

Per chiamare questo metodo, devi disporre di una percentuale pari a budget-id del budget che vuoi aggiornare. Puoi recuperare l'ID budget dall'output di createBudget quando crei il budget o da listBudgets se specifichi tutti i budget.

Prima di utilizzare uno qualsiasi dei 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.

Metodo HTTP e URL:

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

Per inviare la richiesta, espandi una delle seguenti opzioni:

Dovresti ricevere una risposta JSON simile alla seguente:

{}