このドキュメントでは、Service Health API を使用して、単一のプロジェクトに影響するイベントを管理する方法について説明します。
始める前に
Google Cloud プロジェクトに対して課金が有効になっていることを確認します。
- イベントを管理するプロジェクトで Service Health API を有効にします。
- Service Health API にアクセスするための権限を設定します。
参照
使用可能なメソッドとレスポンスのフィールドの意味については、Events API リファレンス(v1、v1beta)をご覧ください。API レスポンスでは、impact リストの各エントリに、影響を受けるプロダクトとロケーションごとに、詳細なサービス中断 state(AFFECTED または RESOLVED)、startTime、endTime(解決済みの場合)が含まれます。
プロダクトまたはロケーションを設定する場合は、Google Cloud プロダクトとロケーションの値を使用します。
プロジェクトのすべてのアクティブなインシデントを一覧表示する
クイックスタートをご覧ください。
インシデントの詳細を取得する
Get API を使用すると、イベントの詳細情報を表示できます。
リクエストのデータを使用する前に、次のように置き換えます。
- API_VERSION: 使用する API のバージョン。
v1またはv1betaを使用してください。 - PROJECT_ID: Google Cloud プロジェクト ID。
- EVENT_ID: イベントの ID。
HTTP メソッドと URL:
GET https://servicehealth.googleapis.com/API VERSION/projects/PROJECT_ID/locations/global/events/EVENT_ID
リクエストを送信するには、次のいずれかのオプションを展開します。
次のような JSON レスポンスが返されます。
{
"name": "projects/PROJECT_ID/locations/global/events/EVENT_ID",
"title": "We are experiencing a connectivity issue affecting Google Cloud SQL in us-east1, australia-southeast2.",
"description": "The issue with Google Cloud SQL has been resolved for all affected projects as of Tuesday, 2022-10-18 11:00 US/Pacific. We thank you for your patience while we worked on resolving the issue.",
"category": "INCIDENT",
"detailedCategory": "CONFIRMED_INCIDENT",
"state": "CLOSED",
"detailedState": "RESOLVED",
"artifacts": [
{
"artifact": "projects/PROJECT_ID/locations/global/artifacts/artifact_id",
"artifactCategory": "ARTIFACT_CATEGORY_INCIDENT_REPORT",
}
],
"eventImpacts": [
{
"product": {
"productName": "Google Cloud SQL",
"id": "hV87iK5DcEXKgWU2kDri",
},
"location": {
"locationName": "us-central1",
}
}
],
"relevance": "RELATED",
"updates": [
{
"updateTime": "2022-10-18T17:41:20.112287Z",
"title": "We are experiencing a connectivity issue affecting Google Cloud SQL in us-east1, australia-southeast2.",
"description": "We are experiencing an intermittent issue with Google Cloud SQL. Our engineering team continues to investigate the issue.",
"symptom": "None at this time.",
"workaround": "None at this time."
},
{
"updateTime": "2022-10-18T18:00:05.690761Z",
"title": "We are experiencing a connectivity issue affecting Google Cloud SQL in us-east1, australia-southeast2.",
"description": "The issue with Google Cloud SQL has been resolved for all affected projects as of Tuesday, 2022-10-18 11:00 US/Pacific.\n\nWe thank you for your patience while we worked on resolving the issue.",
"symptom": "None at this time.",
"workaround": "None at this time."
}
],
"updateTime": "2022-10-18T18:00:05.690761Z",
"startTime": "2022-10-18T17:41:20.112287Z",
"endTime": "2022-10-18T18:00:05.690761Z",
}
イベントを取得する権限がない場合は、次の PERMISSION_DENIED エラーが発生します。
{
"error": {
"code": 403,
"message": "Permission 'servicehealth.events.get' denied on resource '//servicehealth.googleapis.com/projects/PROJECT_ID/locations/global/events/EVENT_ID' (or it may not exist).",
"status": "PERMISSION_DENIED",
"details": [
{
"@type": "type.googleapis.com/google.rpc.ErrorInfo",
"reason": "IAM_PERMISSION_DENIED",
"domain": "servicehealth.googleapis.com",
"metadata": {
"resource": "projects/PROJECT_ID/locations/global/events/EVENT_ID",
"permission": "servicehealth.events.get"
}
}
]
}
}
このエラーを解決するには、必要な権限を設定します。
プロジェクト内の影響を受けるリソースを一覧表示する
サポートされている Google Cloud プロダクトの場合、Personalized Service Health イベントの影響を受けるプロジェクト内の特定の Google Cloud リソースを一覧表示できます。
影響を受けるリソースを一覧表示するには、イベントの開始 24 時間前までにプロジェクトで Service Health API(servicehealth.googleapis.com)を有効にする必要があります。また、プリンシパルに servicehealth.impacts.list 権限(roles/servicehealth.viewer に含まれる)が付与されている必要があります。
REST API(v1beta)
プロジェクト内の影響を受けるリソースを一覧表示するには、次のパラメータを指定して Service Health API にリクエストを送信します。
| パラメータ | 値 | 説明 |
|---|---|---|
parent |
projects/PROJECT_ID/locations/global |
必須。影響を受けるリソースを一覧表示するプロジェクトのプロジェクト ID またはプロジェクト番号。 |
pageSize |
1~100 | 省略可。ページごとに返す影響の最大数。指定しない場合、デフォルトで 10 になります。 |
pageToken |
文字列 | 省略可。結果の次のページを取得するための、前の ListImpactsResponse のトークン。 |
filter |
文字列 | 省略可。返される影響の範囲を絞り込むフィルタ式。たとえば、特定のイベントの影響を受けるリソースを一覧表示するには、filter=events:projects/PROJECT_ID/locations/global/events/EVENT_ID を設定します。 |
リクエストのデータを使用する前に、次のように置き換えます。
PROJECT_ID: Google Cloud プロジェクト ID またはプロジェクト番号。
HTTP メソッドと URL:
GET https://servicehealth.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/impacts
curl を使用するには、GET エンドポイントを直接呼び出します。
curl -X GET \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json; charset=utf-8" \ "https://servicehealth.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/impacts"
gcloud
次のコマンドを実行して、プロジェクト内の影響を受けるリソースを一覧表示します。
gcloud beta service-health impacts list \
--project=PROJECT_ID \
--location=global
特定のイベントの影響を受けるリソースのみを一覧表示するには、--filter フラグを渡します。
gcloud beta service-health impacts list \
--project=PROJECT_ID \
--location=global \
--filter="events:projects/PROJECT_ID/locations/global/events/EVENT_ID"
リクエストが成功すると、レスポンスの本文に次のような Impact オブジェクトのリストが含まれます。
{
"impacts": [
{
"name": "projects/my-project/locations/global/impacts/f9a8b7c6-d5e4-4f3a-9b2c-1d0e9f8a7b6c",
"events": [
"projects/my-project/locations/global/events/1234567890abcdef"
],
"asset": {
"assetName": "//cloudsql.googleapis.com/projects/9876543210/instances/prod-orders-db",
"assetType": "sqladmin.googleapis.com/Instance"
},
"description": "Instance experienced elevated connection errors during regional network disruption.",
"createTime": "2026-10-08T14:12:05.120450Z",
"updateTime": "2026-10-08T14:12:05.120450Z"
}
]
}
影響を受けるリソースの一般的なフィルタの例
filter クエリ パラメータ(または Google Cloud CLI の --filter)を渡して、返される Impact レコードを絞り込むことができます。
- 特定のイベントの影響を受けるリソースを一覧表示する:
filter=events:projects/PROJECT_ID/locations/global/events/EVENT_ID - 特定のリソースタイプ(Cloud SQL インスタンスなど)の影響を受けるリソースを一覧表示する:
filter=asset.assetType="sqladmin.googleapis.com/Instance" - 特定のタイムスタンプ以降に更新された影響を受けるリソースを一覧表示する:
filter=updateTime>"2026-10-08T00:00:00Z"
影響を受けるリソースの詳細を取得する
特定の Impact レコードは、IMPACT_ID を使用して取得できます。
REST API(v1beta)
影響を受ける特定のリソース レコードの詳細を取得するには、次のパラメータを指定してリクエストを送信します。
| パラメータ | 値 | 説明 |
|---|---|---|
name |
projects/PROJECT_ID/locations/global/impacts/IMPACT_ID |
必須。取得する Impact レコードの完全なリソース名。 |
HTTP メソッドと URL:
GET https://servicehealth.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/impacts/IMPACT_ID
curl -X GET \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json; charset=utf-8" \ "https://servicehealth.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/impacts/IMPACT_ID"
gcloud
次のコマンドを実行して、影響を受けるリソース レコードの詳細を取得します。
gcloud beta service-health impacts describe IMPACT_ID \
--project=PROJECT_ID \
--location=global
リクエストが成功すると、レスポンスの本文に Impact オブジェクトが含まれます。
{
"name": "projects/my-project/locations/global/impacts/f9a8b7c6-d5e4-4f3a-9b2c-1d0e9f8a7b6c",
"events": [
"projects/my-project/locations/global/events/1234567890abcdef"
],
"asset": {
"assetName": "//cloudsql.googleapis.com/projects/9876543210/instances/prod-orders-db",
"assetType": "sqladmin.googleapis.com/Instance"
},
"description": "Instance experienced elevated connection errors during regional network disruption.",
"createTime": "2026-10-08T14:12:05.120450Z",
"updateTime": "2026-10-08T14:12:05.120450Z"
}