このガイドでは、Cloud Billing Budget API の使用開始に必要な設定手順について説明します。
始める前に
このガイドを読む前に、次の手順を行ってください。
- Cloud Billing Budget API の概要をご覧ください。
- Cloud Billing Budget API の前提条件をご覧ください。
Google Cloud コンソールについて
Google Cloud Console(ドキュメントを表示、コンソールを開く)は、Google Cloud プロダクトを使用するシステムのプロビジョニング、構成、管理、モニタリングに使用されるウェブ UI です。Google Cloud コンソールを使用して、Google Cloud と Cloud Billing のリソースを設定して管理します。
1. プロジェクトを選択または作成する
Google Cloud が提供するサービスを使用するには、プロジェクトを作成する必要があります。プロジェクトを使用して、すべての Google Cloud のリソースがまとめられます。プロジェクトは、共同編集者、有効化された API などのリソース、モニタリング ツール、お支払い情報、認証とアクセス制御で構成されます。1 つのプロジェクトを作成できるほか、複数のプロジェクトを作成してリソース階層内で Google Cloud リソースを構成することもできます。プロジェクトの詳細については、Resource Manager ドキュメントをご覧ください。
プロジェクトに関する推奨事項: Cloud Billing Budget API の使用など、Cloud 請求先アカウントの FinOps と請求管理に必要なすべてのリソースを格納する、別の Google Cloud プロジェクトを作成して使用することをおすすめします。請求管理のユースケースで FinOps 重視のプロジェクトを使用するメリットの詳細をご確認ください。
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
2. 課金を有効にする
Cloud Billing Budget API の呼び出しに使用しているプロジェクトで課金が有効になっていることを確認する必要があります。プロジェクト セクションの推奨事項に従っている場合、これは FinOps または請求管理用の Google Cloud プロジェクトです。
Make sure that billing is enabled for your Google Cloud project.
Cloud 請求先アカウントは、特定の Google Cloud リソースセットに対する支払いを誰が行うかの定義に使用されます。有効になっている API などのリソースは、プロジェクトに整理されています。Cloud 請求先アカウントは、1 つ以上のプロジェクトにリンクできます。プロジェクトの利用料金は、リンクされた請求先アカウントに請求されます。ほとんどの場合、プロジェクトの作成時に請求情報を構成します。詳細については、Cloud Billing のドキュメントをご覧ください。
使用料金
Cloud 請求先アカウントで発生した費用をモニタリングするために、Cloud Billing 予算を設定します。モニタリングする Cloud 請求先アカウントは、Cloud Billing Budget API の呼び出しに使用するプロジェクトにリンクされている Cloud 請求先アカウントと同じものでもかまいません。Google Cloud のお客様は、Cloud Billing Budget API を無料で使用できます。プログラムによる予算通知を構成すると、標準の Pub/Sub 料金が課金されます。
3. API を有効にする
Cloud Billing Budget API の呼び出しに使用しているプロジェクトで Cloud Billing Budget API を有効にする必要があります。プロジェクト セクションの推奨事項に従っている場合、これは FinOps または請求管理用の Google Cloud プロジェクトです。
API の有効化の詳細については、サービス使用状況のドキュメントをご覧ください。
Enable the Cloud Billing Budget API.
4. 認証と権限付与の設定
Cloud Billing Budget API を使用する場合は、認証を設定する必要があります。API を使用するクライアント アプリケーションはすべて、認証によって ID を確認する必要があります。詳しくは、Cloud Billing に対する認証をご覧ください。
Google アカウントやサービス アカウントなど、特定のプリンシパルとして認証を行います。このプリンシパルには、Cloud Billing Budget API に必要な権限を含む Identity and Access Management(IAM)ロールが必要です。
予算の管理に必要な権限がプリンシパルに付与されるようにするため、請求先アカウントの請求先アカウント管理者(roles/billing.admin
)IAM ロールをプリンシパルに付与するよう管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織へのアクセスを管理するをご覧ください。
管理者は、カスタムロールや他の事前定義ロールを使用して、プリンシパルに必要な権限を付与することもできます。
請求先アカウントにロールを付与する方法については、Cloud Billing の権限を更新するをご覧ください。
5. gcloud CLI をインストールして初期化する
Cloud Billing Budget API を使用する場合は、Google Cloud CLI をインストールして初期化する必要があります。Google Cloud CLI は、Google Cloud でホストされるリソースやアプリケーションの管理に使用できる一連のツールです。これには gcloud CLI が含まれます。次のリンクで手順を説明します。
Install the Google Cloud CLI, then initialize it by running the following command:
gcloud init
6 SDK と認証をテストする
前の手順で認証を設定した場合は、gcloud CLI を使用して認証環境をテストできます。次のコマンドを実行し、エラーが発生せず、認証情報が返されることを確認します。
gcloud auth print-access-token
このコマンドは、Cloud Billing Budget API のコマンドライン REST サンプルのすべてで API 呼び出しの認証に使用されます。
7. Cloud Billing Budget API クライアント ライブラリをインストールする
Cloud Billing Budget API は HTTP と JSON を基に構築されているため、標準の HTTP クライアントであれば、この API にリクエストを送信してレスポンスを解析できます。
API を呼び出すには、次の 3 つのオプションがあります。
Google がサポートするクライアント ライブラリ(推奨)
クライアント ライブラリでは、言語の統合性が高く、セキュリティも強化されています。また、ユーザーの承認が必要な呼び出しもサポートしています。Google がサポートするクライアント ライブラリは、複数のよく使われている言語で利用できます。このライブラリを使用することをおすすめします。