列出服务

本文档介绍了如何列出 Google Cloud 项目、文件夹或组织中已启用或可用的 API 和服务。可用或已启用的 API 和服务的列表可以包含公共Google Cloud 服务（如 Pub/Sub）以及任何以私密方式共享给您的 API 和服务（例如使用 Cloud Endpoints 创建的服务）。如需详细了解公共和专用 API 和服务之间的差异，请参阅公共服务和专用服务。

如需针对 Service Usage API 进行编程，您还可以使用某个 Service Usage 客户端库。

准备工作

如需列出已启用和可用的 API 和服务，您需要：

列出组织或文件夹中已启用的服务

如需列出组织或文件夹中已启用的服务，请完成以下步骤：

gcloud

如需列出组织或文件夹的已启用 API 和服务，请使用 gcloud beta services list 命令：

gcloud beta services list RESOURCE_TYPE=RESOURCE_ID

替换以下内容：

  • RESOURCE_TYPE：使用 --organization 或 --folder 分别列出组织或文件夹的已启用服务。

  • RESOURCE_ID：输入您要列出已启用服务的组织或文件夹的 ID。

REST API

如需列出组织或文件夹的已启用服务，请调用 consumerPolicies.get 方法：

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" "https://serviceusage.googleapis.com/v2beta/RESOURCE_TYPE/RESOURCE_ID/consumerPolicies/default?filter=state:ENABLED"

替换以下内容：

  • RESOURCE_TYPE：使用 organizations 或 folders 分别列出组织或文件夹的已启用服务。

  • RESOURCE_ID：输入您要列出已启用服务的组织或文件夹的 ID。

如果成功，响应正文会包含一个 ConsumerPolicy，其中包含已启用 API 的列表：

{
  "name": "organizations/organization-name/consumerPolicies/default",
  ...
  "enableRules": [
    {
    "services": [
      "services/apphub.googleapis.com",
      "services/appoptimize.googleapis.com",
      "services/artifactregistry.googleapis.com",
      ...
      ]
    }
  ]
}

列出项目中的已启用服务

如需列出项目中的已启用服务，请完成以下步骤：

控制台

要列出项目中已启用的 API 和服务，请执行以下操作：

  1. 在 Google Cloud 控制台中，前往 API 和服务页面。

    进入“API 和服务”

  2. 通过执行以下任一操作来选择 Google Cloud 项目：

    • 从可用列表中选择一个近期的项目。

    • 点击选择项目，找到您的项目，然后点击项目名称。

    系统会打开 API 和服务页面，其中列出了Google Cloud 项目中已启用的 API。

gcloud

如需列出当前项目中已启用的 API 和服务，请使用 gcloud services list 命令：

gcloud services list

输出类似于以下内容：

NAME: analyticshub.googleapis.com
TITLE: Analytics Hub API

NAME: appoptimize.googleapis.com
TITLE: App Optimize API

NAME: artifactregistry.googleapis.com
TITLE: Artifact Registry API

NAME: bigquery.googleapis.com
TITLE: BigQuery API
...

REST API

如需列出项目中已启用的服务，请使用 state:ENABLED 过滤条件调用 services.list 方法：

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" "https://serviceusage.googleapis.com/v1/projects/PROJECT_ID/services?filter=state:ENABLED"

将 PROJECT_ID 替换为您的 Google Cloud 项目 ID 或编号。

列出项目中的可用服务

如需列出项目中的可用服务，请完成以下步骤。可用服务集很少会发生变化，可以长时间缓存。

控制台

要列出项目中可用的 API 和服务，请执行以下操作：

  1. 在 Google Cloud 控制台中，前往 API 库页面。

    转到 API 库

  2. 通过执行以下任一操作来选择 Google Cloud 项目：

    • 从可用列表中选择一个近期的项目。

    • 点击选择项目，找到您的项目，然后点击项目名称。

    系统会打开 API 库页面。您可以搜索或浏览可用的 API。

gcloud

如需列出当前项目中可用的 API 和服务，请使用带有 --available 标志的 gcloud services list 命令：

gcloud services list --available

结果包括已启用的任何服务，以及可为当前项目启用的服务。 输出类似于以下内容：

NAME: places-backend.googleapis.com
TITLE: Google Places API Web Service

NAME: clouderrorreporting.googleapis.com
TITLE: Stackdriver Error Reporting API

NAME: analyticsreporting.googleapis.com
TITLE: Google Analytics Reporting API

NAME: youtube.googleapis.com
TITLE: YouTube Data API v3
...

REST API

如需列出项目的可用服务，请调用 services.list 方法：

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" "https://serviceusage.googleapis.com/v1/projects/PROJECT_ID/services"

将 PROJECT_ID 替换为您的 Google Cloud 项目 ID 或编号。

结果包括所有公共服务、调用用户具有 servicemanagement.services.bind 权限的所有服务，以及已在项目中启用的所有服务。

您可以在请求中添加查询参数 ?filter=state:DISABLED，以过滤结果并排除项目中已启用的服务。

后续步骤