サービスの一覧表示

このドキュメントでは、 Google Cloud プロジェクト、フォルダ、組織で有効になっている、または使用可能な API やサービスを一覧表示する方法について説明します。使用可能または有効になっている API やサービスの一覧には、Pub/Sub などの公開されている Google Cloud サービスと、Cloud Endpoints を使用して作成されたサービスのような、個人的に共有されている API やサービスの両方が含まれている可能性があります。公開 API と非公開 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 を含めると、プロジェクトで有効になっているサービスを除外するように結果をフィルタできます。

次のステップ