クイックスタート: Service Health API を使用してプロジェクトまたは組織に影響するイベントを一覧表示する

このドキュメントでは、 Google Cloud プロジェクトまたは組織の Google Cloud プロダクトに影響を与えている、または影響を与えた可能性がある Personalized Service Health イベントを一覧表示する方法について説明します。Personalized Service Health API を使用します。

始める前に

  1. Service Health API がまだ有効になっていない場合は、有効にします。

    API を有効にするために必要なロール

    API を有効にするには、serviceusage.services.enable 権限が必要です。プロジェクトを作成した場合は、オーナーロール(roles/owner)を介してこの権限がすでに付与されている可能性があります。それ以外の場合は、Service Usage 管理者ロール(roles/serviceusage.serviceUsageAdmin)を介してこの権限を取得できます。ロールを付与する方法を確認する。

    gcloud services enable servicehealth.googleapis.com
  2. Google Cloud プロジェクトに対して課金が有効になっていることを確認します。

  3. このガイドで既存のプロジェクトを使用する場合は、このガイドを完了するために必要な権限があることを確認します。新しいプロジェクトを作成した場合は、必要な権限がすでに付与されています。

必要なロール

Service Health イベントを一覧表示するために必要な権限を取得するには、イベントを一覧表示するプロジェクトまたは組織に対する Personalized Service Health 閲覧者(roles/servicehealth.viewer)IAM ロールを付与するよう管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織に対するアクセス権の管理をご覧ください。

必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

参照

使用可能なメソッドとレスポンスのフィールドの意味については、Events(v1、v1beta)、Impacts(v1beta)、OrganizationEvents(v1、v1beta)、OrganizationImpacts(v1、v1beta)の API リファレンスをご覧ください。

プロダクトまたはロケーションを設定する場合は、Google Cloud プロダクトとロケーションの値を使用します。

プロジェクトのすべてのアクティブなインシデントを一覧表示する

特定の Google Cloud プロジェクトのすべての Google Cloud インシデントを一覧表示できます。

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

  • API_VERSION: 使用する API のバージョン。v1 または v1beta を使用してください。
  • PROJECT_ID: プロジェクトの ID。

HTTP メソッドと URL:

GET https://servicehealth.googleapis.com/API_VERSION/projects/PROJECT_ID/locations/global/events?filter=state=ACTIVE%20category=INCIDENT&page_size=2&page_token={page_token}

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

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

{
  "events": [
    {
      "name": "projects/PROJECT_ID/locations/global/events/event-123",
      "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. We thank you for your patience while we worked on resolving the issue.",
      "category": "INCIDENT",
      "detailedCategory": "CONFIRMED_INCIDENT",
      "state": "ACTIVE",
      "detailedState": "CONFIRMED",
      "eventImpacts": [
        {
          "product": {
            "productName": "Google Cloud SQL",
            "id": "hV87iK5DcEXKgWU2kDri",
          },
          "location": {
            "locationName": "asia-east2",
          }
        },
        {
          "product": {
            "productName": "Google Cloud SQL",
            "id": "hV87iK5DcEXKgWU2kDri",
          },
          "location": {
            "locationName": "asia-southeast1",
          }
        }
      ],
      "relevance": "RELATED",
      "updateTime": "2022-10-18T17:44:05.690761Z",
      "startTime": "2022-10-18T17:41:20.112287Z",
    },
    {
      "name": "projects/PROJECT_ID/locations/global/events/event-567",
      "title": "Cloud Firestore may experience errors.",
      "description": "Mitigation work is currently underway by our engineering team. The mitigation is expected to complete by 2022-10-07T16:30:00Z.",
      "category": "INCIDENT",
      "detailedCategory": "CONFIRMED_INCIDENT",
      "state": "ACTIVE",
      "detailedState": "CONFIRMED",
      "eventImpacts": [
        {
          "product": {
            "productName": "Cloud Firestore",
            "id": "CETSkT92V21G6A1x28me",
          },
          "location": {
            "locationName": "us-central1-a",
          }
        }
      ],
      "relevance": "RELATED",
      "updateTime": "2022-10-07T15:19:59.409530Z",
      "startTime": "2022-10-07T15:10:35.887125Z",
      "nextUpdateTime": "2022-10-07T16:30:00Z"
    }
  ],
  "nextPageToken": "CgwIw8bDmgYQz4nUlgMQChomcHJvamVjdHMvcHNoLW1hbnVhbC"
}

イベントを一覧表示するために必要な権限がない場合は、PERMISSION_DENIED エラーが発生します。

{
  "error": {
    "code": 403,
    "message": "Permission 'servicehealth.events.list' denied on resource '//servicehealth.googleapis.com/projects/PROJECT_ID/locations/global' (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",
          "permission": "servicehealth.events.list"
        }
      }
    ]
  }
}

組織のすべてのアクティブなインシデントを一覧表示する

特定の Google Cloud 組織で Personalized Service Health が有効になっているプロジェクトに影響するすべての Google Cloud インシデントを一覧表示できます。

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

  • API_VERSION: 使用する API バージョン。v1 または v1beta を使用してください。
  • ORGANIZATION_ID: Google Cloud 組織 ID。
  • PROJECT_ID: 割り当てと課金に使用されるプロジェクト ID。

HTTP メソッドと URL:

GET https://servicehealth.googleapis.com/API_VERSION/organizations/ORGANIZATION_ID/locations/global/organizationEvents?filter=state=ACTIVE%20category=INCIDENT&page_size=2&page_token={page_token}

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

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

{
  "organization_events": [
    {
      "name": "organizations/ORGANIZATION_ID/locations/global/organizationEvents/event-123",
      "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. We thank you for your patience while we worked on resolving the issue.",
      "category": "INCIDENT",
      "detailedCategory": "CONFIRMED_INCIDENT",
      "state": "ACTIVE",
      "detailedState": "CONFIRMED",
      "eventImpacts": [
        {
          "product": {
            "productName": "Google Cloud SQL",
            "id": "hV87iK5DcEXKgWU2kDri",
          },
          "location": {
            "locationName": "asia-east2",
          }
        },
        {
          "product": {
            "productName": "Google Cloud SQL",
            "id": "hV87iK5DcEXKgWU2kDri",
          },
          "location": {
            "locationName": "asia-southeast1",
          }
        }
      ],
      "updateTime": "2022-10-18T17:44:05.690761Z",
      "startTime": "2022-10-18T17:41:20.112287Z",
    },
    {
      "name": "organizations/ORGANIZATION_ID/locations/global/organizationEvents/event-567",
      "title": "Cloud Firestore may experience errors.",
      "description": "Mitigation work is currently underway by our engineering team. The mitigation is expected to complete by 2022-10-07T16:30:00Z.",
      "category": "INCIDENT",
      "detailedCategory": "CONFIRMED_INCIDENT",
      "state": "ACTIVE",
      "detailedState": "CONFIRMED",
      "eventImpacts": [
        {
          "product": {
            "productName": "Cloud Firestore",
            "id": "CETSkT92V21G6A1x28me",
          },
          "location": {
            "locationName": "us-central1-a",
          }
        }
      ],
      "updateTime": "2022-10-07T15:19:59.409530Z",
      "startTime": "2022-10-07T15:10:35.887125Z",
      "nextUpdateTime": "2022-10-07T16:30:00Z"
    }
  ],
  "nextPageToken": "CgwIw8bDmgYQz4nUlgMQChomcHJvamVjdHMvcHNoLW1hbnVhbC"
}

ORGANIZATION_ID を取得するには、組織リソース ID の取得をご覧ください。

イベントを一覧表示する権限がない場合は、PERMISSION_DENIED エラーが発生します。

{
  "error": {
    "code": 403,
    "message": "Permission 'servicehealth.organizationEvents.list' denied on resource '//servicehealth.googleapis.com/organizations/ORGANIZATION_ID/locations/global' (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": "organizations/<var class="readonly">ORGANIZATION_ID</var>/locations/global",
          "permission": "servicehealth.organizationEvents.list"
        }
      }
    ]
  }
}

イベントの影響を受ける可能性のある組織内のプロジェクトを一覧表示する

特定の Google Cloud 組織に属するすべてのプロジェクトのうち、次の条件を満たすものを一覧表示できます。

  • イベント(OrganizationImpact)の影響を受ける可能性があります。
  • Personalized Service Health を有効にしている。

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

  • API_VERSION: 使用する API バージョン。v1 または v1beta を使用してください。
  • EVENT_ID: 組織に影響を及ぼしている可能性のあるイベントの ID。
  • ORGANIZATION_ID: Google Cloud 組織 ID。
  • PROJECT_ID: 割り当てと課金に使用されるプロジェクト ID。

HTTP メソッドと URL:

GET https://servicehealth.googleapis.com/API_VERSION/organizations/ORGANIZATION_ID/locations/global/organizationImpacts?filter=events:organizations%2FORGANIZATION_ID%2Flocations%2Fglobal%2FEVENT_ID&page_size=2&page_token={page_token}

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

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

{
  "organization_impacts": [
    {
      "name": "organizations/ORGANIZATION_ID/locations/global/organizationImpacts/impact-123",
      "events": [
        "organizations/ORGANIZATION_ID/locations/global/organizationEvents/EVENT_ID",
      ],
      "asset": {
        "assetName": "//cloudresourcemanager.googleapis.com/projects/{PROJECT_NUMBER_1}",
        "assetType": "cloudresourcemanager.googleapis.com/Project",
      },
      "updateTime": "2022-10-18T17:44:05.690761Z",
    },
    {
      "name": "organizations/ORGANIZATION_ID/locations/global/organizationImpacts/impact-234",
      "events": [
        "organizations/ORGANIZATION_ID/locations/global/organizationEvents/EVENT_ID",
      ],
      "asset": {
        "assetName": "//cloudresourcemanager.googleapis.com/projects/{PROJECT_NUMBER_2}",
        "assetType": "cloudresourcemanager.googleapis.com/Project",
      },
      "updateTime": "2022-10-18T17:44:05.690761Z",
    }
  ],
  "nextPageToken": "CgwIw8bDmgYQz4nUlgMQChomcHJvamVjdHMvcHNoLW1hbnVhbC"
}

イベントを一覧表示する権限がない場合は、次の PERMISSION_DENIED エラーが発生します。

{
  "error": {
    "code": 403,
    "message": "Permission 'servicehealth.organizationImpacts.list' denied on resource '//servicehealth.googleapis.com/organizations/ORGANIZATION_ID/locations/global' (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": "organizations/ORGANIZATION_ID/locations/global",
          "permission": "servicehealth.organizationImpacts.list"
        }
      }
    ]
  }
}

プロジェクト内の影響を受けるリソースを一覧表示する

サポートされている Google Cloud プロダクトの場合、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"
}

次のステップ

Service Health API を使用してプロジェクトまたは組織ごとにイベント情報を取得する方法を確認する。