Cloud Billing Budget API の使用

簡単なリクエストを Cloud Billing Budget API に送信する方法について説明します。

すべてのメソッドの一覧については、REST API または RPC 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 請求先アカウントに設定されているすべての予算を表示します。

REST とコマンドライン

後述のリクエストのデータを使用する前に、次のように置き換えます。

  • billing-account-id: 予算が適用される Google Cloud 請求先アカウント ID。

HTTP メソッドと URL:

GET https://billingbudgets.googleapis.com/v1beta1/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 が必要です。予算 ID は、予算の作成時に createBudget の出力から取得できます。また、すべての予算のリストを表示した場合は、listBudgets の出力から取得できます。

後述のリクエストのデータを使用する前に、次のように置き換えます。

  • billing-account-id: この予算が適用される Google Cloud 請求先アカウント ID。
  • budget-id: 取得する予算の ID。

HTTP メソッドと URL:

GET https://billingbudgets.googleapis.com/v1beta1/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 請求先アカウントに適用される Cloud Billing 予算を作成します。

REST とコマンドライン

このサンプルでは、指定した Google Cloud プロジェクトに範囲を限定(フィルタリング)して、特定の請求先アカウントの予算を作成する方法を示します。

後述のリクエストのデータを使用する前に、次のように置き換えます。

  • project-id: 予算の範囲budgetFilter)として設定する Google Cloud プロジェクト ID。
  • billing-account-id: この予算が適用される Google Cloud 請求先アカウント ID。

HTTP メソッドと URL:

POST https://billingbudgets.googleapis.com/v1beta1/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 が必要です。予算 ID は、予算の作成時に createBudget の出力から取得できます。また、すべての予算のリストを表示した場合は、listBudgets の出力から取得できます。

後述のリクエストのデータを使用する前に、次のように置き換えます。

  • project-id: 予算の範囲budgetFilter)として設定する Google Cloud プロジェクト ID。
  • billing-account-id: この予算が適用される Google Cloud 請求先アカウント ID。
  • budget-id: 更新する予算の ID。

HTTP メソッドと URL:

PATCH https://billingbudgets.googleapis.com/v1beta1/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 が必要です。予算 ID は、予算の作成時に createBudget の出力から取得できます。また、すべての予算のリストを表示した場合は、listBudgets の出力から取得できます。

後述のリクエストのデータを使用する前に、次のように置き換えます。

  • billing-account-id: この予算が適用される Google Cloud 請求先アカウント ID。
  • budget-id: 削除する予算の ID。

HTTP メソッドと URL:

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

リクエストを送信するには、次のいずれかのオプションを展開します。

次のような JSON レスポンスが返されます。

{}