启用 Monitoring API

本页介绍了如何启用并授权使用 Monitoring API v3。您必须先启用此 API，然后才能使用它。

启用 Monitoring API

如需确定 Monitoring API 是否已启用或启用该 API，请使用 Google Cloud 控制台或 Google Cloud CLI。

Google Cloud 控制台

  1. 在 Google Cloud 控制台中，选择要为其启用该 API 的 Google Cloud 项目，然后转到 API 和服务页面：

    转到 API 和服务

  2. 点击启用 API 和服务按钮。

  3. 搜索“Monitoring”。

  4. 在搜索结果中，点击“Stackdriver Monitoring API”。

  5. 如果显示“API 已启用”，则表示此 API 已启用。如果未显示，请点击启用。

gcloud CLI

  1. 如果您尚未在工作站上安装 Google Cloud CLI，请参阅安装 gcloud CLI。

  2. 如需查看是否已启用 Monitoring API，请在将 PROJECT_ID 替换为要为其启用该 API 的项目的 ID 后在工作站上运行以下命令：

    gcloud services list --project=PROJECT_ID

    如果输出中显示 monitoring.googleapis.com，则表示已启用 API。

  3. 如果未启用该 API，请运行以下命令启用它。

    gcloud services enable monitoring --project=PROJECT_ID

    如需了解详情，请参阅 gcloud services。

授权使用 Monitoring API

对 Monitoring API 的访问权限由 Identity and Access Management (IAM) 角色和权限控制。每个方法都有一个关联的权限，相关方法的权限被汇集到角色中，然后再将角色授予用户。如需了解详情，请参阅使用 IAM 控制访问权限。

获得对 API 的访问授权后，就可以在任何地方使用该 API。例如，您可以从本地工作站调用 timeSeries.list 方法。您还可以使用该 API 针对可表示为受监控的资源的任何实体发送指标。如需查看可用类型的列表，请参阅适用于用户定义指标的受监控资源类型。

如果您在编写使用推荐的客户端库的应用，这些库会使用应用默认凭据向您的应用授权。

在某些情况下，您可能还可以使用 API 密钥，但通常建议使用服务账号。API 密钥在没有后端服务器的浏览器和移动应用等客户端中很有用。如需了解详情，请参阅使用 API 密钥。

如需详细了解身份验证和授权，请参阅我们的身份验证指南。