列出服務

本文說明如何列出在 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:分別使用 organizationsfolders 列出機構或資料夾已啟用的服務。

  • 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 控制台中,前往「APIs & Services」(API 與服務) 頁面。

    前往「API 與服務」頁面

  2. 選取 Google Cloud 專案,方法如下:

    • 從可用清單中選取近期專案。

    • 按一下「選取專案」,找出專案,然後按一下專案名稱。

    「API 和服務」頁面隨即開啟,列出專案中已啟用的 API。Google Cloud

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 Library」(API 程式庫) 頁面。

    前往 API 程式庫

  2. 選取 Google Cloud 專案,方法如下:

    • 從可用清單中選取近期專案。

    • 按一下「選取專案」,找出專案,然後按一下專案名稱。

    「API 程式庫」頁面隨即開啟。您可以搜尋或瀏覽可用的 API。

gcloud

如要列出目前專案可用的 API 與服務,請使用 gcloud services list 指令搭配 --available 旗標:

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 查詢參數。

後續步驟