このドキュメントでは、次の操作を行うために権限を設定してアクセスを有効にする方法について説明します。
- Service Health ダッシュボードを使用して Personalized Service Health イベントを表示する。
- Service Health API を使用して Service Health 情報を取得する。
- プロジェクトに関連するアラートを構成する。
始める前に
Google Cloud プロジェクトに対して課金が有効になっていることを確認します。
Service Health API とダッシュボードにアクセスする
Service Health API とダッシュボードにアクセスするために必要な権限を取得するには、プロジェクトに対するPersonalized Service Health Viewer (roles/servicehealth.viewer)IAM ロールを付与するよう管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織に対するアクセス権の管理をご覧ください。
必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。
gcloud CLI でロールと権限を直接使用して、適切なアクセス制御を設定できます。たとえば、次のコマンドを使用してロールを直接付与できます。
gcloud projects add-iam-policy-binding PROJECT_ID \
--member {USER|GROUP|SERVICE_ACCOUNT} \
--role roles/servicehealth.viewer
次のコマンドを使用して、指定したプロジェクトの Identity and Access Management(IAM)ポリシーを表示できます。
gcloud projects get-iam-policy PROJECT_ID
または、既存のロールに権限を直接追加することもできます。
gcloud iam roles update ROLE_ID \
--project=PROJECT_ID \
--permissions="servicehealth.events.get,servicehealth.events.list,servicehealth.impacts.get,servicehealth.impacts.list,servicehealth.locations.get,servicehealth.locations.list,servicehealth.organizationEvents.get,servicehealth.organizationEvents.list,servicehealth.organizationImpacts.get,servicehealth.organizationImpacts.list,servicehealth.statuses.get,resourcemanager.projects.get,resourcemanager.projects.list"
影響を受けるリソースの詳細へのアクセスを制御する(プレビュー)
servicehealth.impacts.list 権限と servicehealth.impacts.get 権限は、事前定義された Service Health 閲覧者のロール(roles/servicehealth.viewer)と、基本の閲覧者、編集者、オーナーのロール(roles/viewer、roles/editor、roles/owner)に含まれています。
サービスの中断がプロジェクト内の特定のリソースに影響する場合、これらの権限により、プリンシパルはプロジェクト全体で影響を受けるリソースの完全なリソース名(assetName)とリソースタイプ(assetType)を表示できます。
プロジェクト内で影響を受ける個々のリソースの名前を表示せずに、プリンシパルがプロジェクト レベルの Service Health イベントを表示できるようにするには、servicehealth.events.get と servicehealth.events.list を含み、servicehealth.impacts.get と servicehealth.impacts.list を除外するカスタムロールを作成します。
gcloud iam roles create EVENT_ONLY_ROLE_ID --project=PROJECT_ID \
--title="Service Health Event-Only Viewer" \
--description="Grants access to Service Health project events without resource-level impact details" \
--permissions="servicehealth.events.get,servicehealth.events.list,servicehealth.locations.get,servicehealth.locations.list,servicehealth.statuses.get,resourcemanager.projects.get"
プロジェクトで API とサービスを使用する
- プロジェクトで Service Health API を有効にします。
- Service Usage コンシューマーロール(
roles/serviceusage.serviceUsageConsumer)を付与します。
ログにアクセスしてログアラートを構成する
手順は次のとおりです。
- プロジェクトで Service Health API を有効にします。
- ログベースのアラートの権限を取得します。
Monitoring NotificationChannel 編集者ロール(roles/monitoring.notificationChannelEditor)を付与しない場合は、代わりに Monitoring NotificationChannel 閲覧者ロール(roles/monitoring.notificationChannelViewer)を付与して、通知チャンネルをアラート ポリシーにリンクできるようにします。
ロールの付与の詳細については、アクセスの管理をご覧ください。
必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。
単一のプロジェクトで Service Health API を有効にする
アラートを設定して Service Health 情報を取得するには、Service Health API を有効にする必要があります。API は、Google Cloud コンソールまたは Google Cloud CLI から有効にできます。
コンソール
API とサービス ライブラリで、Service Health API に移動します。
または、API ライブラリに移動して「Service Health API」を検索します。
プロジェクトを選択します。
[有効にする] ボタンを選択します。
gcloud
-
Google Cloud コンソールで Cloud Shell をアクティブにします。
Google Cloud CLI の最新バージョンがインストールされていることを確認します。Cloud Shell から次のコマンドを実行します。
gcloud components update
新しいプロジェクト
PROJECT_IDを作成または選択します。Google Cloud プロジェクトを作成します。
gcloud projects create PROJECT_ID
作成した Google Cloud プロジェクトを選択します。
gcloud projects config set project PROJECT_ID
作成したプロジェクトで Service Health API を有効にします。
gcloud services enable servicehealth.googleapis.com \ --project PROJECT_ID
スクリプト
スクリプトを使用して、組織またはフォルダ内のプロジェクトで Service Health API を有効にできます。
Service Health API とアラートは、API の有効化から数時間後に新しいイベントを認識します。