快速入门：使用 Service Health API 列出影响项目或组织的事件

本文档介绍了如何列出可能会影响 或已经影响 Google Cloud 您的 Google Cloud 项目或 组织中的产品的服务健康状况事件。您将使用 Service Health API。

准备工作

  1. 启用 Service Health API：

    启用 API 所需的角色

    如需启用 API，您需要拥有 serviceusage.services.enable 权限。如果您 创建了项目，则您可能已通过 所有者角色 (roles/owner) 拥有此权限。否则，您可以通过 Service Usage Admin 角色 (roles/serviceusage.serviceUsageAdmin) 获得此权限。 了解如何授予角色。 

    gcloud services enable servicehealth.googleapis.com

  2. 验证是否已为您的 Google Cloud 项目启用结算功能。

  3. 如果您要使用现有项目来完成本指南，请验证您是否拥有 完成本指南所需的权限。如果您创建了新项目，则您已拥有所需的权限。

所需的角色

如需获得列出服务健康状况事件所需的权限，请让您的管理员为您授予要为其列出事件的项目或组织的Personalized Service Health Viewer (roles/servicehealth.viewer) IAM 角色。如需详细了解如何授予角色，请参阅管理对项目、文件夹和组织的访问权限。

您也可以通过自定义 角色或其他预定义 角色来获取所需的权限。

参考

如需了解可使用的方法以及响应中字段的含义，请参阅 Events (v1,v1beta)、 OrganizationEvents (v1,v1beta) 和 OrganizationImpacts (v1, v1beta) API 参考。

设置产品或位置时，请使用 Google Cloud 产品和 位置中的值。

列出项目的所有活跃突发事件

您可以列出特定 Google Cloud 项目的所有 Google Cloud 突发事件。

在使用任何请求数据之前， 请先进行以下替换：

  • API_VERSION：要使用的 API 版本。请使用 v1 或 v1beta。
  • PROJECT_ID：项目的 ID。

HTTP 方法和网址： 

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}