サービスの一覧表示

このドキュメントでは、Google Cloud プロジェクトで有効になっている、または使用可能な API やサービスを一覧表示する方法について説明します。使用可能または有効になっている API やサービスの一覧には、Pub/Sub などの公開されている Google Cloud サービスと、Cloud Endpoints を使用して作成されたサービスのような、個人的に共有されている API やサービスの両方が含まれている可能性があります。公開 API と非公開 API サービスの相違について詳しくは、一般公開サービスと非公開サービスをご覧ください。

  • 組織で有効なサービスを取得またはモニタリングするには、組織で有効なサービスを一覧表示するをご覧ください。
  • プロジェクト内のサービスを一覧表示するには、Google Cloud コンソールまたは Google Cloud CLI を使用することをおすすめします。このドキュメントでは、両方のインターフェースの使用方法について説明します。
  • Service Management API に対してプログラミングするには、Google が提供するクライアント ライブラリのいずれかを使用します。
  • API を試すには、curl コマンドを使用することをおすすめします。 全てのアプリケーション環境を設定する必要はありませんが、設定が必要なものもあります。

始める前に

有効で使用可能な API とサービスを一覧表示するには、以下が必要です。

  • Google Cloud プロジェクト Google Cloud プロジェクトの作成方法については、プロジェクトの作成と管理をご覧ください。
  • 適切な Identity and Access Management 権限。Service Usage に関する IAM の要件については、アクセス制御をご覧ください。
  • Google Cloud CLI のインストール。
  • このガイドのcurlの例を使用する場合は、スタートガイドの指示に従って初期設定を完了してください。この手順には、標準 curl コマンドの認証済みエイリアスである gcurl と環境変数 PROJECT_NUMBER の定義が含まれています。

組織で有効なサービスを一覧表示する

組織全体で有効になっているサービスを一覧表示するには、Cloud Asset Inventory を使用します。これにより、組織の管理下にあるすべてのプロジェクトの状態を 1 回の RPC 呼び出しでエクスポートできます。Cloud Asset Inventory を使用して、状態の変化をモニタリングすることもできます。 特定の組織で有効なサービスをすべてエクスポートするには、Cloud Asset Inventory のドキュメントでアセットの一覧表示をご確認ください。

組織で有効になっている API を一覧表示するには、組織 ID と請求プロジェクト ID を設定した後、次のコマンドを実行します。

NOW=$(TZ=GMT date +"%Y-%m-%dT%H:%M:%SZ")
gcloud asset list \
--organization='ORGANIZATION_ID' \
--billing-project='BILLING_PROJECT_ID' \
--asset-types='serviceusage.googleapis.com/Service' \
--snapshot-time=$NOW \
--content-type='resource'

上記のコマンドを実行すると、十分な権限を付与されたユーザーは、組織内のすべてのプロジェクトに対して有効になっているサービスのセットを一覧表示できます。

Cloud Asset Inventory コマンドを試すには、これらのコマンドを特定のプロジェクトに適用します。たとえば、次のコマンドは、特定のプロジェクトに対して有効なすべてのサービスを一覧表示します。

NOW=$(TZ=GMT date +"%Y-%m-%dT%H:%M:%SZ")
gcloud asset list \
--project='PROJECT_ID' \
--billing-project='BILLING_PROJECT_ID' \
--asset-types='serviceusage.googleapis.com/Service' \
--snapshot-time=$NOW \
--content-type='resource'

プロジェクトで有効なサービスを一覧表示する

有効なサービスを一覧表示すると、serviceusage.googleapis.com/list_enabled_requests 割り当て指標の割り当てが使用されます。デフォルトの使用可能な割り当ての秒間クエリ数(QPS)は 10 です。

コンソール

プロジェクトで有効な API とサービスを一覧表示するには:

  1. Google Cloud コンソールの [API ダッシュボード] ページに移動します。
    [API ダッシュボード] ページに移動
  2. 次のいずれかの方法で、Google Cloud プロジェクトを選択します。

    • [最近のプロジェクトの選択] で Google Cloud プロジェクトをクリックします。

    • 次の手順に沿って、Google Cloud プロジェクト ブラウザを使用します。

      1. [プロジェクトを選択] をクリックして、Google Cloud プロジェクト ブラウザを開きます。
      2. プロジェクトを見つけて、Google Cloud プロジェクト名をクリックします。
      3. [開く] をクリックしてプロジェクトを開きます。

    [API とサービス] ページが表示されます。このページの表で、Google Cloud プロジェクトで有効になっている API のリストを確認できます。

gcloud

現在のプロジェクトで有効な API とサービスを一覧表示するには、次のコマンドを実行します。

gcloud services list

このコマンドによって、次のような出力が生成されます。

NAME                                              TITLE
pubsub.googleapis.com             Google Cloud Pub/Sub API
bigquery.googleapis.com           BigQuery API
cloudtrace.googleapis.com         Stackdriver Trace API
servicemanagement.googleapis.com  Google Service Management API
monitoring.googleapis.com         Stackdriver Monitoring API
storage-api.googleapis.com        Google Cloud Storage JSON API
logging.googleapis.com            Stackdriver Logging API
clouddebugger.googleapis.com      Stackdriver Debugger API
...

curl

有効になっているサービスを一覧表示するには、state:ENABLED フィルタを使用して services.list メソッドを呼び出します。

プロジェクトで有効な API とサービスを一覧表示するには、次のコマンドを実行します。

gcurl "https://serviceusage.googleapis.com/v1/projects/${PROJECT_NUMBER}/services?filter=state:ENABLED"

プロジェクトで使用可能なサービスの一覧表示

使用可能なすべてのサービスを一覧表示すると、serviceusage.googleapis.com/list_available_requests 割り当ての割り当てが使用されます。デフォルトの使用可能な割り当ては 1 QPS です。使用可能なサービスのセットはまれにしか変更されないため、キャッシュに長期間保存することができます。

コンソール

プロジェクトで使用可能な API とサービスを一覧表示するには:

  1. Google Cloud コンソールの [API ライブラリ] ページに移動します。
    [API ライブラリ] ページに移動
  2. 次のいずれかの方法で、Google Cloud プロジェクトを選択します。

    • [最近のプロジェクトの選択] で Google Cloud プロジェクトをクリックします。

    • 次の手順に沿って、Google Cloud プロジェクト ブラウザを使用します。

      1. [プロジェクトを選択] をクリックして、Google Cloud プロジェクト ブラウザを開きます。
      2. プロジェクトを見つけて、Google Cloud プロジェクト名をクリックします。
      3. [開く] をクリックしてプロジェクトを開きます。

    [API ライブラリ] 画面が表示されます。この画面から、使用可能な API を検索またはスクロールできます。

gcloud

現在のプロジェクトで使用可能な API とサービスを一覧表示するには、次のコマンドを実行します。

gcloud services list --available

結果には、すでに有効化されているサービスと、現在のプロジェクトに対して有効にできるサービスが含まれます。 このコマンドによって、次のような出力が生成されます。

NAME                                              TITLE
places-backend.googleapis.com                  Google Places API Web Service
clouderrorreporting.googleapis.com             Stackdriver Error Reporting API
analyticsreporting.googleapis.com              Google Analytics Reporting API
youtube.googleapis.com                         YouTube Data API v3
adsense.googleapis.com                         AdSense Management API
sqladmin.googleapis.com                        Google Cloud SQL API
genomics.googleapis.com                        Genomics API
adexchangebuyer.googleapis.com                 Ad Exchange Buyer API II
...

curl

使用可能なサービスを一覧表示するには、services.list メソッドを呼び出します。

プロジェクトで使用可能な API とサービスを一覧表示するには、次のコマンドを実行します。

gcurl "https://serviceusage.googleapis.com/v1/projects/${PROJECT_NUMBER}/services"

結果には、すべての公開サービス、呼び出し元のユーザーがservicemanagement.services.bind権限を持っているすべてのサービス、およびプロジェクトですでに有効になっているすべてのサービスが含まれています。

filter=state:DISABLED を前の呼び出しに渡すことで、プロジェクトで現在アクティブなサービスを除外できます。

次のステップ

Google Cloud プロジェクトでサービスを有効または無効にする方法については、サービスの有効化と無効化をご覧ください。