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

Antes de ler este guia, faça o seguinte:

  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 sua conta de faturamento

Para todas as chamadas da API Cloud Billing Budget, você precisará do ID da sua conta de faturamento.

  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 por nome e ID. Localize o ID da conta de faturamento em que você gerenciará os orçamentos.

Captura de tela da página

Como chamar a API

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

É possível aplicar um orçamento a uma conta de faturamento inteira ou com escopo (filtrado) a um subconjunto de projetos e/ou produtos. Para isso, use filtros de orçamento granulares a fim de monitorar partes específicas dos custos em grupos de projetos e serviços.

Listar orçamentos

Nesse método de API, todos os orçamentos definidos para uma determinada Conta de faturamento do Cloud são listados.

REST e LINHA DE COMANDO

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

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

Método HTTP e URL:

GET https://billingbudgets.googleapis.com/v1beta1/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 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"
    }
  ]
}

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 Google Cloud a que este orçamento é aplicado.
  • budget-id: o ID do orçamento que você quer receber.

Método HTTP e URL:

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

Criar orçamento

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

REST e LINHA DE COMANDO

Nesta amostra, apresentamos como criar um orçamento para uma determinada conta de faturamento que está com escopo (filtrada) por um projeto do Google Cloud que você especifica.

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 Google Cloud a que este orçamento é aplicado.

Método HTTP e URL:

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

Corpo JSON da solicitação:

{
  "budget": {
    "displayName": "Keep my spending down",
    "budgetFilter": {
      "projects": [
        "projects/project-id"
      ]
    },
    "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"
  },
  "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 valor, filtros (escopo) ou limites de alerta dele.

REST e LINHA DE COMANDO

Nesta amostra, apresentamos como atualizar um orçamento atual e definir um escopo (filtro) por um projeto do Google Cloud que você especifica.

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 Google Cloud a que este orçamento é aplicado.
  • budget-id: o ID do orçamento que você quer atualizar.

Método HTTP e URL:

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

Corpo JSON da solicitação:

{
  "budget": {
    "displayName": "My fancy budget",
    "budgetFilter": {
      "projects": [
        "projects/project-id"
      ]
    },
   "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"
  },
  "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 Google Cloud a que este orçamento é aplicado.
  • budget-id: o ID do orçamento que você quer excluir.

Método HTTP e URL:

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

{}