为开发环境设置 Service Usage

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

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

设置环境以直接调用 API

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

启用 Service Usage API

如需使用 Service Usage API，您必须先在要使用该 API 的 Google Cloud 项目中启用它：

  1. 进入 Google Cloud 控制台的 API 库页面。
    转到“API 库”页面
  2. 选择您要用于访问服务的 Google Cloud 项目。
  3. 在“API 库”页面上，点击启用。
  4. 确保您的用户账号具有 Service Usage Admin 角色。

用 curl 进行测试

  1. 为调用 Google REST API 定义一个方便的 shell 别名：

    alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

  2. 使用项目的标识符设置环境变量 PROJECT_ID。这可以是项目 ID 或编号：

    PROJECT_ID="my-project-id"

  3. 确保您已登录“gcloud”：

    gcloud auth login

  4. 列出此项目中已启用的 API 和服务：

    gcurl "https://serviceusage.googleapis.com/v1/projects/${PROJECT_ID}/services?filter=state:ENABLED&fields=services.config.title,services.config.name"

    如果您看到如下所示的输出，则表示设置成功：

    {
"services": [
  {
    "config": {
      "name": "bigquery.googleapis.com",
      "title": "BigQuery API"
    }
  },
  {
    "config": {
      "name": "bigquerystorage.googleapis.com",
      "title": "BigQuery Storage API"
    }
  },
  ...

后续步骤

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