使用入门

本页介绍如何设置开发环境以使用 Service Usage API。

  • 对于大多数操作用例,启用和停用服务的最简单方法是使用 Google Cloud Console。
  • 如果需要创建脚本,可以使用 gcloud 命令行界面。
  • 如果您需要针对 Service Usage API 进行编程,请使用某个客户端库
  • 如需试用 API,您可以按照本指南中的备用设置说明进行操作,并使用 curl 命令来测试 API,而无需设置完整的应用开发环境。

设置环境以直接调用 API

本节描述了通过使用 curl 命令的 Service Usage API 设置本地环境以进行试验所必需的基本步骤。本使用入门适用于需要针对 Service Usage API 进行编程的开发者。

启用 Service Usage API

要使用 Service Usage API,必须首先在要使用该 API 的 Cloud 项目中启用它:

  1. 转到 Google Cloud Console API 库页面。
    转到“API 库”页面
  2. 点击选择以选择您要用于访问服务的 Cloud 项目。
  3. 在“API 库”页面上,点击启用

创建服务帐号

在本部分中,您将创建服务帐号和密钥以运行 curl 命令:

  1. 转到 Cloud Console 服务帐号页面。
    转到“服务帐号”页面
  2. 点击选择以选择您要用于访问服务的 Cloud 项目。
  3. 创建一个服务帐号。如需了解如何创建服务帐号,请参阅创建和管理服务帐号。 如要按照本节中的说明进行操作,必须授予服务帐号 roles/serviceusage.serviceUsageAdmin 角色。如需了解如何向服务帐号授予角色,请参阅向服务帐号授予角色
  4. 转到 Cloud Console API 凭据页面。
    转到“API 凭据”页面
  5. 为新服务帐号创建服务帐号密钥,并将其 JSON 凭据文件下载到本地计算机上。本指南中的示例假设文件路径为 ~/credentials.json。如要了解如何创建服务帐号密钥,请参阅创建和管理服务帐号密钥
  6. 在本地计算机上安装 oauth2l,以便与 Google OAuth 系统进行互动。

用 curl 进行测试

  1. 首先验证您的初始设置:

    oauth2l header --json ~/credentials.json cloud-platform
    
  2. 完成 OAuth 流程后,您应该会看到类似于以下内容的输出:

    Authorization: Bearer y29.xxxxxxx
    
  3. 为调用 Google REST API 定义一个方便的 shell 别名:

    alias gcurl='curl -H "$(oauth2l header --json ~/credentials.json cloud-platform userinfo.email)" -H "Content-Type: application/json"'
    
  4. 尝试列出项目中可用和已启用的 API 和服务:

    gcurl https://serviceusage.googleapis.com/v1/projects/357084163378/services
    

    如果您看到服务列表,则说明设置成功。

后续步骤

按照列出服务列出 Cloud 项目中已启用或可用的 API 和服务。