Como usar a API Cloud Billing Budget

Saiba como enviar algumas solicitações simples para a API Cloud Billing Budget.

Para acessar uma lista completa de métodos, consulte a documentação de referência da API REST ou da API RPC.

Antes de começar

Faça o seguinte antes de ler este guia:

  1. Leia a visão geral da API Cloud Billing Budget.
  2. Leia os pré-requisitos da API Cloud Billing Budget.
  3. Execute as etapas de configuração.

Identificar o ID da conta de faturamento do Cloud

Para cada chamada da API Cloud Billing Budget, você precisará do ID da conta de faturamento do Cloud.

  1. Acesse a página "Gerenciar contas de faturamento" do Console do Google Cloud.
  2. Na guia Minhas contas de faturamento, você vê a lista de contas do Cloud Billing por nome e ID. Localize o ID da conta de faturamento em que você gerenciará os orçamentos.

Captura de tela da página "Gerenciar contas faturamento" com o local do ID da conta de faturamento.

Principais conceitos do orçamento

Limitação de cota: uma única conta de faturamento do Cloud pode ter até 5.000 orçamentos associados a ela de cada vez. Consulte Cotas e limites para mais informações.

Como chamar a API

Nos exemplos a seguir, mostramos como enviar algumas solicitações simples à API Cloud Billing Budget.

Listar orçamentos

Esse método de API lista todos os orçamentos disponíveis para uma determinada conta de faturamento do Cloud.

REST e LINHA DE CMD

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

  • billing-account-id: o ID da conta de faturamento do Cloud a que os orçamentos são aplicados.

Método HTTP e URL:

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

Para enviar a solicitação, expanda uma destas opções:

Você receberá uma resposta JSON semelhante a esta:

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

Receber orçamento

Nesse método de API, receba os detalhes de um determinado orçamento.

REST e LINHA DE CMD

Para chamar esse método, você precisa do budget-id do orçamento que quer atualizar. Receba o ID do orçamento da saída createBudget, ao criar o orçamento, ou da saída listBudgets, se você listar todos os seus orçamentos.

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

  • billing-account-id: o ID da conta de faturamento do Cloud a que esse orçamento se aplica.
  • budget-id: o ID do orçamento que você quer receber.

Método HTTP e URL:

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

Para enviar a solicitação, expanda uma destas opções:

Você receberá uma resposta JSON semelhante a esta:

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

Criar orçamento

Nesse método de API, é criado um orçamento do Cloud Billing aplicado à conta de faturamento do Cloud especificada.

REST e LINHA DE CMD

Este exemplo mostra como criar um orçamento para uma determinada conta do Cloud Billing que está com escopo (filtrada) por um projeto do Google Cloud que você especifica e define para um período de calendário de um trimestre.

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

  • project-id: o ID do projeto do Google Cloud que você quer definir como um escopo de orçamento (budgetFilter).
  • billing-account-id: o ID da conta de faturamento do Cloud a que esse orçamento se aplica.

Método HTTP e URL:

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

Corpo JSON da solicitação:

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

Para enviar a solicitação, expanda uma destas opções:

Você receberá uma resposta JSON semelhante a esta:

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

Atualizar orçamento

Use esse método de API para modificar um orçamento do Faturamento do Cloud atual para alterar o valor do orçamento, os filtros de orçamento (escopo), o período do orçamento ou as regras de limite.

REST e LINHA DE CMD

Nesta amostra, apresentamos como atualizar um orçamento existente para definir um escopo (filtro) por um projeto do Google Cloud que você especifica e para atualizar o período do orçamento de um mês. a um orçamento trimestral.

Para chamar esse método, você precisa do budget-id do orçamento que quer atualizar. Receba o ID do orçamento da saída createBudget, ao criar o orçamento, ou da saída listBudgets, se você listar todos os seus orçamentos.

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

  • project-id: o ID do projeto do Google Cloud que você quer definir como um escopo de orçamento (budgetFilter).
  • billing-account-id: o ID da conta de faturamento do Cloud a que esse orçamento se aplica.
  • budget-id: o ID do orçamento que você quer atualizar.

Método HTTP e URL:

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

Corpo JSON da solicitação:

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

Para enviar a solicitação, expanda uma destas opções:

Você receberá uma resposta JSON semelhante a esta:

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

Excluir orçamento

Use esse método de API para excluir um orçamento atual do Faturamento do Cloud.

REST e LINHA DE CMD

Para chamar esse método, você precisa do budget-id do orçamento que quer atualizar. Receba o ID do orçamento da saída createBudget, ao criar o orçamento, ou da saída listBudgets, se você listar todos os seus orçamentos.

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

  • billing-account-id: o ID da conta de faturamento do Cloud a que esse orçamento se aplica.
  • budget-id: o ID do orçamento que você quer excluir.

Método HTTP e URL:

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

Para enviar a solicitação, expanda uma destas opções:

Você receberá uma resposta JSON semelhante a esta:

{}