Usa la API de presupuesto de Facturación de Cloud

Obtén más información sobre cómo enviar algunas solicitudes simples a la API de presupuesto de Facturación de Cloud.

Para obtener una lista completa de métodos, consulta la documentación de referencia de la API de REST o la API de RPC.

Antes de comenzar

Debes hacer lo siguiente antes de leer esta guía:

  1. Consulta Descripción general de la API de presupuesto de Facturación de Cloud.
  2. Consulta Requisitos previos de la API de presupuesto de Facturación de Cloud.
  3. Realiza los pasos de configuración.

Identifica el ID de tu cuenta de facturación

Para cada llamada a la API de presupuesto de Facturación de Cloud, necesitarás tu ID de cuenta de facturación.

  1. Ve a la página Manage billing accounts (Administrar cuentas de facturación) de Google Cloud Console.
  2. En la pestaña My billing accounts (Mis cuentas de facturación), verás la lista de cuentas de facturación por ID y nombre. Busca el Billing account ID (ID de la cuenta de facturación) de la cuenta en la que administrarás los presupuestos.

Captura de pantalla de la página Manage billing (Administrar facturación) que muestra la ubicación del ID de tu cuenta de facturación.

Llama a la API

En los siguientes ejemplos, se muestra cómo enviar algunas solicitudes simples a la API de presupuesto de Facturación de Cloud.

Un presupuesto se puede aplicar a una cuenta de facturación completa o se puede reducir el alcance (filtrar) a un subconjunto de proyectos o productos mediante filtros de presupuesto detallados para supervisar segmentos específicos de tus costos entre grupos de proyectos y servicios.

Enumera los presupuestos

Este método de API enumera todos los presupuestos configurados para una cuenta de facturación de Cloud determinada.

LÍNEA DE CMD Y REST

Antes de usar cualquiera de los datos de solicitud siguientes, realiza los reemplazos a continuación:

  • billing-account-id: El ID de la cuenta de facturación de Google Cloud a la que se aplican los presupuestos.

Método HTTP y URL:

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

Para enviar tu solicitud, expande una de estas opciones:

Deberías recibir una respuesta JSON similar a la que se muestra a continuación:

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

Obtén el presupuesto

Este método de API obtiene los detalles de un presupuesto determinado.

LÍNEA DE CMD Y REST

Para llamar a este método, necesitas el budget-id del presupuesto que deseas actualizar. Puedes obtener el ID de presupuesto del resultado createBudget cuando creas tu presupuesto, o del resultado listBudgets si enumeras todos tus presupuestos.

Antes de usar cualquiera de los datos de solicitud siguientes, realiza los reemplazos a continuación:

  • billing-account-id: El ID de la cuenta de facturación de Google Cloud a la que se aplica este presupuesto.
  • budget-id: El ID del presupuesto que deseas obtener.

Método HTTP y URL:

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

Para enviar tu solicitud, expande una de estas opciones:

Deberías recibir una respuesta JSON similar a la que se muestra a continuación:

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

Crear presupuesto

Este método de la API crea un presupuesto de Facturación de Cloud aplicado a la cuenta de facturación de Cloud especificada.

LÍNEA DE CMD Y REST

En este ejemplo, se muestra cómo crear un presupuesto para una cuenta de facturación determinada que tiene una reducción de alcance (filtro) según el proyecto de Google Cloud que especifiques.

Antes de usar cualquiera de los datos de solicitud siguientes, realiza los reemplazos a continuación:

  • project-id: El ID del proyecto de Google Cloud que deseas establecer como un alcance del presupuesto (budgetFilter).
  • billing-account-id: El ID de la cuenta de facturación de Google Cloud a la que se aplica este presupuesto.

Método HTTP y URL:

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

Cuerpo JSON de la solicitud:

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

Para enviar tu solicitud, expande una de estas opciones:

Deberías recibir una respuesta JSON similar a la que se muestra a continuación:

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

Actualiza el presupuesto

Usa este método de la API con el fin de modificar un presupuesto existente de Facturación de Cloud para cambiar el importe del presupuesto, los filtros (alcance del presupuesto) o los límites de alerta.

LÍNEA DE CMD Y REST

En este ejemplo, se muestra cómo actualizar un presupuesto existente y configurar un alcance (filtro) según el proyecto de Google Cloud que especifiques.

Para llamar a este método, necesitas el budget-id del presupuesto que deseas actualizar. Puedes obtener el ID de presupuesto del resultado createBudget cuando creas tu presupuesto, o del resultado listBudgets si enumeras todos tus presupuestos.

Antes de usar cualquiera de los datos de solicitud siguientes, realiza los reemplazos a continuación:

  • project-id: El ID del proyecto de Google Cloud que deseas establecer como un alcance del presupuesto (budgetFilter).
  • billing-account-id: El ID de la cuenta de facturación de Google Cloud a la que se aplica este presupuesto.
  • budget-id: El ID del presupuesto que deseas actualizar.

Método HTTP y URL:

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

Cuerpo JSON de la solicitud:

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

Para enviar tu solicitud, expande una de estas opciones:

Deberías recibir una respuesta JSON similar a la que se muestra a continuación:

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

Borrar un presupuesto

Usa este método de la API para borrar un presupuesto existente de Facturación de Cloud.

LÍNEA DE CMD Y REST

Para llamar a este método, necesitas el budget-id del presupuesto que deseas actualizar. Puedes obtener el ID de presupuesto del resultado createBudget cuando creas tu presupuesto, o del resultado listBudgets si enumeras todos tus presupuestos.

Antes de usar cualquiera de los datos de solicitud siguientes, realiza los reemplazos a continuación:

  • billing-account-id: El ID de la cuenta de facturación de Google Cloud a la que se aplica este presupuesto.
  • budget-id: El ID del presupuesto que deseas borrar.

Método HTTP y URL:

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

Para enviar tu solicitud, expande una de estas opciones:

Deberías recibir una respuesta JSON similar a la que se muestra a continuación:

{}