Esta página foi traduzida pela API Cloud Translation.

Usar a API Cloud Billing Budget

Saiba como enviar alguns pedidos simples para a API Cloud Billing Budget.

Para ver 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, deve fazer o seguinte:

Leia a vista geral da API Cloud Billing Budget.
Leia os pré-requisitos da API Cloud Billing Budget.
Realize os passos de configuração.

Identifique o ID da sua conta de faturação do Google Cloud

Para cada chamada da API Cloud Billing Budget, precisa do seu ID da conta do Cloud Billing.

Aceda à Google Cloud página de gestão de contas de faturação da consola.
No separador As minhas contas de faturação, é apresentada a lista de contas de faturação do Google Cloud por nome e ID. Localize o ID da conta de faturação da conta onde vai gerir os orçamentos.

Captura de ecrã da página Gerir faturação que mostra a localização do ID da conta de faturação.

Conceitos de orçamento principais

Pode aplicar um orçamento a uma conta de faturação inteira ou definir o âmbito (filtrado) usando filtros de orçamento detalhados para monitorizar partes específicas dos seus custos.
Um orçamento aplicado a uma conta de faturação do Google Cloud inteira inclui os custos de todos os Google Cloud projetos pagos por essa conta de faturação.
Se tiver acesso limitado ou nenhum acesso à conta do Cloud Billing, pode criar orçamentos de projeto único para projetos que lhe pertencem. Se for um utilizador ao nível da conta de faturação do Google Cloud, pode criar orçamentos de projeto único que não podem ser modificados por utilizadores ao nível do projeto através do campo OwnershipScope no orçamento.
Pode restringir o âmbito do orçamento através de filtros, como um subconjunto de organizações, pastas, projetos, serviços e outros filtros de orçamento aplicáveis à sua conta de faturação do Google Cloud.
Pode especificar o período do orçamento. Por predefinição, um orçamento monitoriza os custos acumulados durante um mês civil. Com o filtro usage_period disponível na API Cloud Billing Budget, pode configurar o período de tempo do orçamento para CalendarPeriod ou CustomPeriod, o que lhe permite criar orçamentos para monitorizar prazos além do mês civil predefinido, como um trimestre, um ano ou um intervalo de datas personalizado que especificar.
Pode definir o valor do orçamento para um total que especificar ou basear o valor do orçamento nos gastos do período do calendário anterior.
Pode definir regras de limite de orçamento para acionar notificações de alerta por email. Quando os seus custos (custos reais ou custos previstos) excedem uma percentagem do seu orçamento (com base nas regras que definir), são enviados emails de alerta aos destinatários que especificar.
Pode definir as regras de notificação do orçamento para especificar os destinatários de email dos alertas de orçamento e para ativar notificações programáticas através do Pub/Sub.
Pode usar tópicos do Pub/Sub para notificações programáticas (por exemplo, para encaminhar as suas mensagens de orçamento para outros meios, como o Slack, ou para automatizar tarefas de gestão de custos).

Limitação de quota: cada conta de faturação do Google Cloud individual pode ter vários milhares de orçamentos associados em simultâneo. Consulte Quotas e limites para ver os limites atuais e informações adicionais.

Chamar a API

Os exemplos seguintes mostram como enviar alguns pedidos simples para a API Cloud Billing Budget.

Listar orçamentos

Este método da API apresenta todos os orçamentos disponíveis para uma determinada conta de faturação do Google Cloud.

REST

Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:

billing-account-id: o ID da conta do Cloud Billing à qual os orçamentos se aplicam.
project-id: o Google Cloud projeto onde a API Cloud Billing Budget está ativada.

Método HTTP e URL:

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

Para enviar o seu pedido, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Nota: O comando seguinte pressupõe que tem sessão iniciada na CLI gcloud com a sua conta de utilizador executando gcloud init ou gcloud auth login, ou usando o Cloud Shell, que inicia automaticamente sessão na CLI gcloud. Pode verificar a conta atualmente ativa executando o comando gcloud auth list.

Execute o seguinte 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)

Nota: O comando seguinte pressupõe que iniciou sessão na CLI do Google Cloud com a sua conta de utilizador executando gcloud init ou gcloud auth login .gcloud Pode verificar a conta atualmente ativa executando o comando gcloud auth list.

Execute o seguinte 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

Deve receber uma resposta JSON semelhante à seguinte:

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

Obtenha o orçamento

Este método da API obtém os detalhes de um orçamento específico.

REST

Para chamar este método, precisa do budget-id do orçamento que quer atualizar. Pode obter o ID do orçamento a partir do resultado createBudget quando cria o orçamento ou do resultado listBudgets se listar todos os orçamentos.

Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:

billing-account-id: O ID da conta de faturação do Google Cloud ao qual este orçamento se aplica.
budget-id: o ID do orçamento que quer obter.
project-id: o Google Cloud projeto onde a API Cloud Billing Budget está ativada.

Método HTTP e URL:

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

Para enviar o seu pedido, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Execute o seguinte 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)

Execute o seguinte 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

Deve receber uma resposta JSON semelhante à seguinte:

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

Crie um orçamento

Este método da API cria um orçamento do Cloud Billing aplicado à conta do Cloud Billing especificada.

REST

Este exemplo mostra como criar um orçamento para uma determinada conta de faturação do Google Cloud que é delimitado (filtrado) por um Google Cloud projeto que especifica e define para um período de tempo do calendário de um trimestre.

Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:

projects/budget-scope-project-id: o Google Cloud ID do projeto que quer definir como um âmbito do orçamento (budgetFilter).
billing-account-id: O ID da conta de faturação do Google Cloud ao qual este orçamento se aplica.
api-user-project-id: o projeto onde a API Cloud Billing Budget está ativada. Google Cloud

Método HTTP e URL:

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

Corpo JSON do pedido:

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

Para enviar o seu pedido, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Guarde o corpo do pedido num ficheiro com o nome request.json, e execute o seguinte 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)

Guarde o corpo do pedido num ficheiro com o nome request.json, e execute o seguinte 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

Deve receber uma resposta JSON semelhante à seguinte:

{
  "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 este método da API para modificar um orçamento de faturação na nuvem existente para alterar o valor do orçamento, os filtros do orçamento (âmbito do orçamento), o período do orçamento ou as regras de limite.

REST

Este exemplo mostra como atualizar um orçamento existente para definir um âmbito (filtro) por um Google Cloud projeto especificado e para atualizar o período do orçamento de um orçamento mensal para um orçamento trimestral .

Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:

projects/budget-scope-project-id: o projeto que quer definir como um âmbito do orçamento (budgetFilter). Google Cloud
billing-account-id: O ID da conta de faturação do Google Cloud ao qual este orçamento se aplica.
budget-id: o ID do orçamento que quer atualizar.
api-user-project-id: o Google Cloud projeto onde a API Cloud Billing Budget está ativada.

Método HTTP e URL:

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

Corpo JSON do pedido:

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

Para enviar o seu pedido, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Guarde o corpo do pedido num ficheiro com o nome request.json, e execute o seguinte 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)

Guarde o corpo do pedido num ficheiro com o nome request.json, e execute o seguinte 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

Deve receber uma resposta JSON semelhante à seguinte:

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

Elimine um orçamento

Use este método da API para eliminar um orçamento do Cloud Billing existente.

REST

Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:

billing-account-id: O ID da conta de faturação do Google Cloud ao qual este orçamento se aplica.
budget-id: o ID do orçamento que quer eliminar.
project-id: o Google Cloud projeto onde a API Cloud Billing Budget está ativada.

Método HTTP e URL:

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

Para enviar o seu pedido, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Execute o seguinte 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)

Execute o seguinte 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

Deve receber uma resposta JSON semelhante à seguinte:

{}

Configuração

Usar a API Cloud Billing Budget Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Antes de começar

Identifique o ID da sua conta de faturação do Google Cloud

Conceitos de orçamento principais

Chamar a API

Listar orçamentos

REST

curl (Linux, macOS ou Cloud Shell)

PowerShell (Windows)

Obtenha o orçamento

REST

curl (Linux, macOS ou Cloud Shell)

PowerShell (Windows)

Crie um orçamento

REST

curl (Linux, macOS ou Cloud Shell)

PowerShell (Windows)

Atualizar orçamento

REST

curl (Linux, macOS ou Cloud Shell)

PowerShell (Windows)

Elimine um orçamento

REST

curl (Linux, macOS ou Cloud Shell)

PowerShell (Windows)

Usar a API Cloud Billing Budget