使用 Cloud Billing Budget API

了解如何向 Cloud Billing Budget API 发送一些简单的请求。

如需查看完整的方法列表,请参阅 REST APIRPC API 参考文档。

准备工作

在阅读本指南之前,请先完成以下各项:

  1. 阅读 Cloud Billing Budget API 概览
  2. 阅读 Cloud Billing Budget API 先决条件
  3. 执行设置步骤

确定您的结算帐号 ID

对于每个 Cloud Billing Budget API 调用,您需要有结算帐号 ID

  1. 转到 Google Cloud Console“管理结算帐号”页面
  2. 在“我的结算帐号”标签页中,按名称和 ID 显示结算帐号列表。找到要用于管理预算的帐号的结算帐号 ID

“管理结算”页的屏幕截图,其中显示了结算帐号 ID 的位置。

调用 API

以下示例展示了如何向 Cloud Billing Budget API 发送一些简单的请求。

您可以将预算应用于整个结算帐号,也可以使用精细预算过滤器将预算范围限制(过滤)为部分项目和/或产品,以监控多组项目和服务的特定费用切片。

列出预算

此 API 方法会列出为特定 Cloud Billing 帐号设置的所有预算。

REST 和命令行

在使用下面的请求数据之前,请先进行以下替换:

  • billing-account-id:预算适用的 Google Cloud Billing 帐号 ID。

HTTP 方法和网址:

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

如需发送您的请求,请展开以下选项之一:

您应会收到如下所示的 JSON 响应:

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

获取预算

此 API 方法可获取特定预算的详细信息。

REST 和命令行

要调用此方法,需要您想更新的预算的 budget-id。您可以在创建预算时从 createBudget 输出获取预算 ID;如果列出所有预算,则可以从 listBudgets 输出获取预算 ID。

在使用下面的请求数据之前,请先进行以下替换:

  • billing-account-id:此预算适用的 Google Cloud 结算帐号 ID。
  • budget-id:您要获得的预算的 ID。

HTTP 方法和网址:

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

如需发送您的请求,请展开以下选项之一:

您应会收到如下所示的 JSON 响应:

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

创建预算

此 API 方法会创建应用于特定 Cloud Billing 帐号的 Cloud Billing 预算

REST 和命令行

此示例展示了如何为特定结算帐号创建根据您指定的 Google Cloud 项目进行范围限制(过滤)的预算。

在使用下面的请求数据之前,请先进行以下替换:

  • project-id:您要设置为预算范围的 Google Cloud 项目 ID(budgetFilter)。
  • billing-account-id:此预算适用的 Google Cloud 结算帐号 ID。

HTTP 方法和网址:

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

请求 JSON 正文:

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

如需发送您的请求,请展开以下选项之一:

您应会收到如下所示的 JSON 响应:

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

更新预算

使用此 API 方法修改现有的 Cloud Billing 预算以更改预算金额、过滤条件(预算范围)或提醒阈值。

REST 和命令行

此示例展示了如何更新现有预算以及如何根据您指定的 Google Cloud 项目设置范围(过滤条件)

要调用此方法,需要您想更新的预算的 budget-id。您可以在创建预算时从 createBudget 输出获取预算 ID;如果列出所有预算,则可以从 listBudgets 输出获取预算 ID。

在使用下面的请求数据之前,请先进行以下替换:

  • project-id:您要设置为预算范围的 Google Cloud 项目 ID(budgetFilter)。
  • billing-account-id:此预算适用的 Google Cloud 结算帐号 ID。
  • budget-id:您要更新的预算的 ID。

HTTP 方法和网址:

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

请求 JSON 正文:

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

如需发送您的请求,请展开以下选项之一:

您应会收到如下所示的 JSON 响应:

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

删除预算

使用此 API 方法删除现有的 Cloud Billing 预算

REST 和命令行

要调用此方法,需要您想更新的预算的 budget-id。您可以在创建预算时从 createBudget 输出获取预算 ID;如果列出所有预算,则可以从 listBudgets 输出获取预算 ID。

在使用下面的请求数据之前,请先进行以下替换:

  • billing-account-id:此预算适用的 Google Cloud 结算帐号 ID。
  • budget-id:要删除的预算的 ID。

HTTP 方法和网址:

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

如需发送您的请求,请展开以下选项之一:

您应会收到如下所示的 JSON 响应:

{}