ESP を使用した GKE 用 Cloud Endpoints のスタートガイド

---

OpenAPI   |  gRPC

このチュートリアルでは、サンプル API と Extensible Service Proxy（ESP）を構成して Google Kubernetes Engine（GKE）クラスタにデプロイする方法を説明します。

サンプルコードの REST API は、OpenAPI 仕様を使用して作成されています。また、API キーを作成し、そのキーを API へのリクエストの送信時に使用する方法についても説明します。

このチュートリアルでは、事前にビルドしたサンプルコードと ESP のコンテナ イメージを使用します（これらは、Container Registry に保存されています）。

Cloud Endpoints の概要については、Endpoints についてと Endpoints アーキテクチャをご覧ください。

目標

タスクの概要を示す次のリストを参照しながら、チュートリアルを実施してください。API にリクエストを送信するには、パート 1 のすべてのタスクを行う必要があります。

パート 1

1. Google Cloud プロジェクトを設定します。始める前にをご覧ください。
2. GKE でコンテナ クラスタを作成します。コンテナ クラスタを作成するをご覧ください。
3. チュートリアルで使用するソフトウェアをインストールして設定します。必須ソフトウェアをインストールして構成するをご覧ください。
4. サンプルコードをダウンロードします。サンプルコードを取得するをご覧ください。
5. Cloud Endpoints の構成に使用する openapi.yaml ファイルを構成します。Endpoints を構成するをご覧ください。
6. Endpoints 構成をデプロイして Endpoints サービスを作成します。Endpoints 構成をデプロイするをご覧ください。
7. API と ESP をクラスタにデプロイします。API バックエンドをデプロイするをご覧ください。
8. クラスタの IP アドレスを取得します。クラスタの外部 IP アドレスを取得するをご覧ください。
9. IP アドレスを使用して API にリクエストを送信します。IP アドレスを使用してリクエストを送信するをご覧ください。
10. API の活動を追跡します。API の活動を追跡するをご覧ください。

パート 2

1. サンプル API の DNS レコードを構成します。Endpoints の DNS を構成するをご覧ください。
2. 完全修飾ドメイン名を使用して API にリクエストを送信します。FQDN を使用してリクエストを送信するをご覧ください。

クリーンアップ

終了したら、クリーンアップを確認して、Google Cloud アカウントに料金が発生しないようにしてください。

料金

このドキュメントでは、Google Cloud の次の課金対象のコンポーネントを使用します。

• GKE
• Endpoints

料金計算ツールを使うと、予想使用量に基づいて費用の見積もりを生成できます。 新しい Google Cloud ユーザーは無料トライアルをご利用いただける場合があります。

このドキュメントに記載されているタスクの完了後、作成したリソースを削除すると、それ以上の請求は発生しません。詳細については、クリーンアップをご覧ください。

準備

1. Google Cloud アカウントにログインします。Google Cloud を初めて使用する場合は、アカウントを作成して、実際のシナリオでの Google プロダクトのパフォーマンスを評価してください。新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分を差し上げます。

2. Google Cloud Console の [プロジェクト セレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

   注: この手順で作成するリソースをそのまま保持する予定でない場合、既存のプロジェクトを選択するのではなく、新しいプロジェクトを作成してください。チュートリアルの終了後にそのプロジェクトを削除すれば、プロジェクトに関連するすべてのリソースを削除できます。

   プロジェクト セレクタに移動

3. Google Cloud プロジェクトで課金が有効になっていることを確認します。

4. Google Cloud Console の [プロジェクト セレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

   注: この手順で作成するリソースをそのまま保持する予定でない場合、既存のプロジェクトを選択するのではなく、新しいプロジェクトを作成してください。チュートリアルの終了後にそのプロジェクトを削除すれば、プロジェクトに関連するすべてのリソースを削除できます。

   プロジェクト セレクタに移動

5. Google Cloud プロジェクトで課金が有効になっていることを確認します。

6. 後で必要になるので、Google Cloud プロジェクト ID はメモしておいてください。

コンテナ クラスタの作成

サンプル API バックエンド コードを動作させるには、GKE にコンテナ クラスタを作成する必要があります。

サンプル API のコンテナ クラスタを作成するには:

1. Google Cloud Console で、GKE クラスタページに移動します。
   

   [Kubernetes クラスタ] ページに移動

2. [クラスタを作成] をクリックします。

3. デフォルト値をそのまま使用して、[作成する] をクリックします。処理が完了するまで数分かかることがあります。

4. クラスタ名とゾーンをメモします。これらはコンテナ クラスタで kubectl の認証を行うときに必要になります。

必須ソフトウェアをインストールして構成する

このチュートリアルでは、Google Cloud CLI を使用してプロジェクトを管理できるように、gcloud CLI をインストールします。GKE クラスタに対してコマンドを実行するには、kubectl を使用します。また、API をテストする手段も必要です。

必須ソフトウェアがすでにインストールされている場合は、次の手順をスキップして先に進んでください。

必須ソフトウェアをインストールして構成するには:

1. サンプル API にリクエストを送信するためのアプリケーションが必要です。

   • Linux ユーザーと MacOS ユーザーの場合: このチュートリアルでは、curl の使用例を示します。これは通常、オペレーティング システムにプリインストールされています。 curl を所有していない場合は、curl のリリースとダウンロードのページからダウンロードできます。
   • Windows ユーザーの場合: このチュートリアルでは、Invoke-WebRequest の使用例を示しています。これは PowerShell 3.0 以降でサポートされています。
2. gcloud CLI をインストールして初期化します。
3. gcloud CLI を更新し、Endpoints コンポーネントをインストールします。

   gcloud components update

4. Google Cloud CLI（gcloud）が、Google Cloud にある対象のデータとサービスへのアクセスが許可されていることを確認します。

   gcloud auth login

   表示された新しいブラウザタブで、アカウントを選択します。
5. プロジェクト ID にデフォルト プロジェクトを設定します。

   gcloud config set project YOUR_PROJECT_ID

   YOUR_PROJECT_ID を実際のプロジェクト ID に置き換えます。他にも Google Cloud プロジェクトがあり、gcloud を使用してそのプロジェクトを管理する場合は、gcloud CLI 構成の管理をご覧ください。

6. kubectl をインストールします。

   gcloud components install kubectl

7. アプリケーションのデフォルト認証情報用に使用する新しいユーザー認証情報を取得します。ユーザー認証情報は kubectl を承認するために必要です。

   gcloud auth application-default login

   表示された新しいブラウザタブで、アカウントを選択します。

サンプルコードをダウンロードする

複数の言語に対応するサンプルコードが用意され、すぐに利用できます。

サンプルをローカルマシンにダウンロードするには:

Java

サンプル API のクローンを作成するか、ダウンロードするには:

1. ローカルマシンにサンプルアプリのリポジトリのクローンを作成します。

   git clone https://github.com/GoogleCloudPlatform/java-docs-samples

   または、zip ファイルとしてサンプルをダウンロードし、ファイルを解凍します。

2. サンプルコードが含まれているディレクトリに移動します。

   cd java-docs-samples/endpoints/getting-started

Python

サンプル API のクローンを作成するか、ダウンロードするには:

1. ローカルマシンにサンプルアプリのリポジトリのクローンを作成します。

   git clone https://github.com/GoogleCloudPlatform/python-docs-samples

   または、zip ファイルとしてサンプルをダウンロードし、ファイルを解凍します。

2. サンプルコードが含まれているディレクトリに移動します。

   cd python-docs-samples/endpoints/getting-started

Go

サンプル API のクローンを作成するか、ダウンロードするには:

1. GOPATH 環境変数が設定されていることを確認します。
2. ローカルマシンにサンプルアプリのリポジトリのクローンを作成します。

   go get -d github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started

3. サンプルコードが含まれているディレクトリに移動します。

   cd $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started

PHP

サンプル API のクローンを作成するか、ダウンロードするには:

1. ローカルマシンにサンプルアプリのリポジトリのクローンを作成します。

   git clone https://github.com/GoogleCloudPlatform/php-docs-samples

   または、zip ファイルとしてサンプルをダウンロードし、ファイルを解凍します。

2. サンプルコードが含まれているディレクトリに移動します。

   cd php-docs-samples/endpoints/getting-started

Ruby

サンプル API のクローンを作成するか、ダウンロードするには:

1. ローカルマシンにサンプルアプリのリポジトリのクローンを作成します。

   git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples

   または、zip ファイルとしてサンプルをダウンロードし、ファイルを解凍します。

2. サンプルコードが含まれているディレクトリに移動します。

   cd ruby-docs-samples/endpoints/getting-started

NodeJS

サンプル API のクローンを作成するか、ダウンロードするには:

1. ローカルマシンにサンプルアプリのリポジトリのクローンを作成します。

   git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples

   または、zip ファイルとしてサンプルをダウンロードし、ファイルを解凍します。

2. サンプルコードが含まれているディレクトリに移動します。

   cd nodejs-docs-samples/endpoints/getting-started

Endpoints の設定

サンプルコードには、OpenAPI 構成ファイル openapi.yaml が含まれています。このファイルは OpenAPI 仕様 v2.0 に準拠しています。

Endpoints を構成するには:

1. サンプルコードのディレクトリで、openapi.yaml 構成ファイルを開きます。
   Java

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   Python

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   Go

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   PHP

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   Ruby

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   NodeJS

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   次の点にご注意ください。

   • 上記の構成サンプルでは host フィールドの近辺に表示されている行を変更する必要があります。openapi.yaml ファイルを Endpoints にデプロイするには、完全な OpenAPI ドキュメントが必要です。
   • サンプル openapi.yaml ファイルには、このチュートリアルでは不要な認証を構成するためのセクションが含まれています。YOUR-SERVICE-ACCOUNT-EMAIL と YOUR-CLIENT-ID の行を構成する必要はありません。
   • OpenAPI は言語に依存しない仕様です。利便性を考慮し、各言語の GitHub リポジトリで、同じ openapi.yaml ファイルが getting-started サンプル内に用意されています。

2. host フィールドで、テキストを次の形式の Endpoints サービス名に置き換えます。

   host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
   

   YOUR_PROJECT_ID を Google Cloud プロジェクト ID に置き換えます。例:

   host: "echo-api.endpoints.example-project-12345.cloud.goog"
   

この echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog は Endpoints サービスの名前です。これは、API にリクエストを送信するために使用する完全修飾ドメイン名（FQDN）ではありません。

Endpoints に必要な OpenAPI ドキュメントのフィールドについては、Endpoints を構成するをご覧ください。

次の構成手順をすべて完了し、IP アドレスを使用してサンプル API にリクエストを正常に送信できるようになったら、Endpoints の DNS を構成するを参照して、echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog を FQDN に構成する方法をご確認ください。

Endpoints 構成をデプロイする

Endpoints の構成をデプロイするには、gcloud endpoints services deploy コマンドを使用します。このコマンドを実行すると、Service Management を使用してマネージド サービスが作成されます。

Endpoints 構成をデプロイするには:

1. endpoints/getting-started ディレクトリ内にいることを確認します。
2. 構成をアップロードしてマネージド サービスを作成します。

   gcloud endpoints services deploy openapi.yaml
   

gcloud コマンドが Service Management API を呼び出して、openapi.yaml ファイルの host フィールドで指定した名前のマネージド サービスを作成します。Service Management は、openapi.yaml ファイル内の設定に従ってサービスを構成します。openapi.yaml に変更を加えるときは、このファイルを再デプロイして Endpoints サービスを更新する必要があります。

Service Management でサービスの作成と構成が行われるとき、情報がターミナルに出力されます。openapi.yaml ファイル内のパスが API キーを要求していないことを示す警告は無視して問題ありません。サービスの構成が完了すると、Service Management に、次のようなサービス構成 ID とサービス名を含むメッセージが表示されます。

Service Configuration [2017-02-13r0] uploaded for service [echo-api.endpoints.example-project-12345.cloud.goog]

上記の例では、2017-02-13r0 はサービス構成 ID、echo-api.endpoints.example-project-12345.cloud.goog は Endpoints サービスです。サービス構成 ID は、日付スタンプとそれに続くリビジョン番号で構成されます。同じ日に openapi.yaml ファイルを再度デプロイすると、サービス構成 ID のリビジョン番号が増分されます。Endpoints のサービス構成は、Google Cloud コンソールの [Endpoints] > [サービス] ページで確認できます。

エラー メッセージが表示された場合は、Endpoints 構成のデプロイのトラブルシューティングをご覧ください。

必要なサービスの確認

Endpoints と ESP を使用するには、少なくとも次の Google サービスの有効化が必要です。

名前	タイトル
servicemanagement.googleapis.com	Service Management API
servicecontrol.googleapis.com	Service Control API
endpoints.googleapis.com	Google Cloud Endpoints

ほとんどの場合、gcloud endpoints services deploy コマンドによってこれらの必須サービスが有効化されます。ただし、以下の状況では、gcloud コマンドは正常に完了しますが、必須サービスが有効になりません。

• Terraform などのサードパーティのアプリケーションを使用していて、上記のサービスを含めていない場合。

• 上記のサービスが明示的に無効にされている既存の Google Cloud プロジェクトに Endpoints 構成をデプロイした場合。

必要なサービスが有効になっていることを確認するには、次のコマンドを実行します。

gcloud services list

必要なサービスが表示されない場合は、次のコマンドを使用してサービスを有効にします。

gcloud services enable servicemanagement.googleapis.com
gcloud services enable servicecontrol.googleapis.com
gcloud services enable endpoints.googleapis.com

Endpoints サービスも有効にします。

gcloud services enable ENDPOINTS_SERVICE_NAME

ENDPOINTS_SERVICE_NAME を確認するには、次のいずれかを行います。

• Endpoints 構成をデプロイ後、Cloud Console の [Endpoints] ページに移動します。[サービス名] 列に、考えられる ENDPOINTS_SERVICE_NAME のリストが表示されます。

• OpenAPI の場合、ENDPOINTS_SERVICE_NAME は OpenAPI 仕様の host フィールドで指定したものです。gRPC の場合、ENDPOINTS_SERVICE_NAME は gRPC Endpoints 構成の name フィールドで指定したものです。

gcloud コマンドの詳細については、gcloud サービスをご覧ください。

API バックエンドをデプロイする

ここまでの手順で OpenAPI ドキュメントを Service Management にデプロイしましたが、API バックエンドを処理するコードはまだデプロイしていません。ここでは、API サンプルと ESP 用に事前にビルドしたコンテナをクラスタにデプロイする手順を説明します。

必要な権限を確認する

ESP と ESPv2 は、IAM を使用して、呼び出し元の ID が、使用されている IAM リソースにアクセスするための十分な権限を持っているかどうかを確認する Google サービスを呼び出します。呼び出し元の ID は、ESP と ESPv2 をデプロイする、接続されたサービス アカウントでます。

接続されたサービス アカウントは、GKE Pod にデプロイされると、ノードのサービス アカウントです。通常、それは、Compute Engine のデフォルト サービス アカウントです。この権限の推奨事項に従って、適切なノードのサービス アカウントを選択してください。

Workload Identity を使用する場合、ノードのサービス アカウントとは別のサービス アカウントを使用して Google サービスと通信できます。Pod 用の Kubernetes サービス アカウントを作成して ESP と ESPv2 を実行し、Google サービス アカウントを作成して Kubernetes サービス アカウントを Google サービス アカウントに関連付けることができます。

この手順に沿って、Kubernetes サービス アカウントを Google サービス アカウントに関連付けます。 この Google サービス アカウントは、接続されているサービス アカウントです。

接続されたサービス アカウントがプロジェクトの Compute Engine のデフォルト サービス アカウントで、エンドポイント サービス構成が同じプロジェクトにデプロイされている場合、サービス アカウントには、IAM リソースにアクセスするための十分な権限があるため、続く IAM ロールの設定手順はスキップできます。これに該当しない場合は、次の IAM ロールを、接続されたサービス アカウントに追加する必要があります。

必要な IAM ロールを追加する

このセクションでは、ESP と ESPv2 で使用される IAM リソースと、これらのリソースにアクセスするために接続されたサービス アカウントに必要な IAM ロールについて説明します。

エンドポイント サービスの構成

ESP と ESPv2 は、エンドポイント サービス構成を使用する Service Control を呼び出します。エンドポイント サービスの構成は IAM リソースであり、ESP と ESPv2 にはサービス コントローラ ロールが必要です。

IAM ロールは、プロジェクトではなく、エンドポイント サービスの構成に対するものです。1 つのプロジェクトには、複数のエンドポイント サービス構成が存在する場合があります。

次の gcloud コマンドを使用して、エンドポイント サービス構成の接続されたサービス アカウントにロールを追加します。

gcloud endpoints services add-iam-policy-binding SERVICE_NAME \
  --member serviceAccount:SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com \
  --role roles/servicemanagement.serviceController

ここで、
* SERVICE_NAME は、エンドポイント サービス名です。
* SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com は、接続されたサービス アカウントです。

Cloud Trace

ESP と ESPv2 は Cloud Trace サービスを呼び出して、Trace をプロジェクトにエクスポートします。このプロジェクトはトレース プロジェクトと呼ばれます。ESP では、トレース プロジェクトと、エンドポイント サービス構成を有するプロジェクトは同じです。ESPv2 では、トレース プロジェクトはフラグ --tracing_project_id で指定できます。デフォルトはデプロイ プロジェクトです。

ESP と ESPv2 では、Cloud Trace を有効にするために、Cloud Trace エージェント ロールが必要です。

次の gcloud コマンドを使用して、接続されたサービス アカウントにロールを追加します。

gcloud projects add-iam-policy-binding TRACING_PROJECT_ID \
  --member serviceAccount:SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com \
  --role roles/cloudtrace.agent

ここで、
* TRACING_PROJECT_ID は、トレース プロジェクト ID です。
* SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com は、接続されたサービス アカウントです。詳細については、ロールと権限についてをご覧ください。

クラスタにコンテナをデプロイする

コンテナは、アプリケーションを実際の実行環境から抽象化する論理パッケージング メカニズムとして機能します。サンプル API と ESP をクラスタにデプロイするには、次の手順に従ってください。

コンテナをクラスタにデプロイするには:

1. クラスタの認証情報を取得し、kubectl で使用できるようにします。

   gcloud container clusters get-credentials NAME 
   
       --zone ZONE

   NAME をクラスタ名、ZONE をクラスタゾーンに置き換えます。
2. GKE クラスタに Kubernetes Service をデプロイします。Kubernetes Service は API を実装します。Kubernetes 構成ファイル /endpoints/getting-started/deployment.yaml を編集します。ESP 起動オプションの SERVICE_NAME は、サービスの名前と置き換えます。
   Java

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:1
     args: [
       "--http_port=8081",
       "--backend=127.0.0.1:8080",
       "--service=SERVICE_NAME",
       "--rollout_strategy=managed",
     ]

   Python

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:1
     args: [
       "--http_port=8081",
       "--backend=127.0.0.1:8080",
       "--service=SERVICE_NAME",
       "--rollout_strategy=managed",
     ]

   Go

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:1
     args: [
       "--http_port", "8081",
       "--backend", "127.0.0.1:8080",
       "--service", "SERVICE_NAME",
       "--rollout_strategy", "managed",
     ]

   PHP

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:1
     args: [
       "--http_port", "8081",
       "--backend", "127.0.0.1:8080",
       "--service", "SERVICE_NAME",
       "--rollout_strategy", "managed",
     ]

   Ruby

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:1
     args: [
       "--http_port", "8081",
       "--backend", "127.0.0.1:8080",
       "--service", "SERVICE_NAME",
       "--rollout_strategy", "managed",
     ]

   NodeJS

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:1
     args: [
       "--http_port", "8081",
       "--backend", "127.0.0.1:8080",
       "--service", "SERVICE_NAME",
       "--rollout_strategy", "managed",
     ]

   次に例を示します。

     args: [
       "--http_port=8081",
       "--backend=127.0.0.1:8080",
       "--service=echo-api.endpoints.example-project-12345.cloud.goog ",
       "--rollout_strategy=managed",
     ]
   

   --rollout_strategy=managed オプションを指定すると、デプロイ済みの最新のサービス構成を使用するように ESP が構成されます。このオプションを指定すると、新しいサービス構成をデプロイしてから 5 分以内に ESP が変更を検出し、自動的に使用します。ESP が特定の構成 ID でなく、このオプションを使用するようにしてください。使用されている他の ESP オプションについては、ESP 起動オプションをご覧ください。

   上記のコンテナ仕様の imagePullPolicy を Always に設定することをおすすめします。この設定により、新しく作成された Pod は常に ESP の最新バージョンを pull することが許可されます。詳細については、構成のベスト プラクティスをご覧ください。ESP の新しいバージョンがリリースされたら、すべての Pod をローリング再起動して、最新バージョンを使用できるようにします。

3. kubectl apply コマンドを使用して、Kubernetes Service を起動します。

   kubectl apply -f deployment.yaml

注: GKE クラスタが非公開の場合は、DNS リゾルバとして Compute Engine メタデータ サーバーを使用して、Google サービスホスト名を解決する必要があります。次の ESP フラグを追加します。 --dns=169.254.169.254

エラー メッセージが表示された場合は、GKE での Endpoints のトラブルシューティングをご覧ください。

詳細については、API バックエンドをデプロイするをご覧ください。

クラスタの外部 IP アドレスを取得する

API にリクエストを送信するには、サービスの外部 IP が必要です。コンテナ内でサービスを開始してから外部 IP アドレスが準備できるまでには、数分かかることがあります。

1. 外部 IP アドレスを表示します。

   kubectl get service
   

2. EXTERNAL-IP の値をメモします。この IP アドレスは、サンプル API にリクエストを送信するときに使用します。

IP アドレスを使用してリクエストを送信する

コンテナ クラスタ内でサービスを実行し、外部 IP アドレスを取得したら、API にリクエストを送信できます。

API キーを作成し、環境変数を設定する

サンプルコードには API キーが必要です。リクエストを簡単にするために、API キーの環境変数を設定します。

1. API に使用したものと同じ Google Cloud プロジェクトの API 認証情報ページで API キーを作成します。別の Google Cloud プロジェクトで API キーを作成するには、Google Cloud プロジェクトでの API の有効化をご覧ください。

   [ドメインの確認] ページに移動

2. [認証情報を作成] をクリックして [API キー] を選択します。
3. キーをクリップボードにコピーします。
4. [閉じる] をクリックします。
5. ローカルマシンで、API キーを貼り付けて環境変数に割り当てます。
   • Linux または Mac OS の場合: export ENDPOINTS_KEY=AIza...
   • Windows PowerShell の場合: $Env:ENDPOINTS_KEY="AIza..."

リクエストを送信する

Linux または Mac OS

前の手順で設定した ENDPOINTS_KEY 環境変数を使用して、curl を使用して HTTP リクエストを送信します。IP_ADDRESS をインスタンスの外部 IP アドレスに置き換えます。

curl --request POST \
   --header "content-type:application/json" \
   --data '{"message":"hello world"}' \
   "http://IP_ADDRESS:80/echo?key=${ENDPOINTS_KEY}"

上記の curl で:

• --data オプションは、API に送信するデータを指定します。
• --header オプションは、データが JSON 形式であることを指定します。

PowerShell

前の手順で設定した ENDPOINTS_KEY 環境変数を使用して、Invoke-WebRequest により HTTP リクエストを送信します。IP_ADDRESS をインスタンスの外部 IP アドレスに置き換えます。

(Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' `
    -Headers @{"content-type"="application/json"} `
    -URI "http://IP_ADDRESS:80/echo?key=$Env:ENDPOINTS_KEY").Content

上記の例では、最初の 2 行はバッククォートで終わります。この例を PowerShell に貼り付けるとき、バッククォートの後にスペースがないことを確認してください。このリクエスト例で使用されているオプションについては、Microsoft のドキュメントの Invoke-WebRequest をご覧ください。

サードパーティ製アプリ

Chrome ブラウザの拡張機能である Postman などのサードパーティのアプリケーションを使用してリクエストを送信できます。

• HTTP 動詞として POST を選択します。
• ヘッダーで、キー content-type とその値 application/json を選択します。
• 本文で、次のように入力します。
  {"message":"hello world"}
• URL で、環境変数ではなく実際の API キーを使用します。 例:
  http://192.0.2.0:80/echo?key=AIza...

API によって送信メッセージがエコーバックされ、次のようなレスポンスが返されます。

{
  "message": "hello world"
}

正常なレスポンスが返されなかった場合は、レスポンス エラーのトラブルシューティングをご覧ください。

これで Endpoints の API のデプロイとテストが完了しました。

注: このチュートリアルについてのご感想やご要望がありましたら、このページの下部からフィードバックをお送りください。いただいたフィードバックは、チュートリアルの品質向上に利用させていただきます。
エラーが発生した場合は、google-cloud-endpoints Google グループに参加して、どのような問題が生じたかをお知らせください。このグループに参加すると、他の Endpoints ユーザーや、このグループをモニタリングしている Google エンジニアから回答を受け取ることができます。

API の活動を追跡する

API のアクティビティを追跡するには:

1. [エンドポイント] > [サービス] ページで API のアクティビティ グラフを確認します。
   

   [Endpoints] の [サービス] ページに移動

   
   グラフにリクエストが反映されるまでに、しばらく時間がかかる場合があります。

2. [ログ エクスプローラ] ページで、API のリクエストログを確認します。
   

   [ログ エクスプローラ] ページに移動

Endpoints の DNS を構成する

API の Endpoints サービス名は .endpoints.YOUR_PROJECT_ID.cloud.goog ドメイン中にあるため、openapi.yaml ファイルの構成を少し変更することで、完全修飾ドメイン名（FQDN）として使用できます。このようにすると、サンプル API にリクエストを送信するときに IP アドレスの代わりに echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog を使用できます。

Endpoints DNS を構成するには:

1. OpenAPI 構成ファイルである openapi.yaml を開き、次のスニペットに示すように、ファイルの最上位レベルに x-google-endpoints プロパティを追加（インデントまたはネストさせずに）します。

   host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
   x-google-endpoints:
   - name: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
     target: "IP_ADDRESS"
   

2. name プロパティで、YOUR_PROJECT_ID を実際のプロジェクト ID で置き換えます。
3. target プロパティで、IP_ADDRESS をサンプル API にリクエストを送信する際に使用した IP アドレスで置き換えます。
4. 更新した OpenAPI 構成ファイルを Service Management にデプロイします。

   gcloud endpoints services deploy openapi.yaml
   

たとえば、openapi.yaml ファイルは次のように構成されていると仮定します。

host: "echo-api.endpoints.example-project-12345.cloud.goog"
x-google-endpoints:
- name: "echo-api.endpoints.example-project-12345.cloud.goog"
  target: "192.0.2.1"

前述の gcloud コマンドで openapi.yaml ファイルをデプロイすると、Service Management はターゲット IP アドレス 192.0.2.1 に解決される DNS A レコード echo-api.endpoints.my-project-id.cloud.goog を作成します。新しい DNS 構成が反映されるまでに数分かかる場合があります。

SSL を設定する

DNS と SSL の構成方法の詳細については、Endpoints で SSL を有効にするをご覧ください。

FQDN を使用してリクエストを送信する

サンプル API の DNS レコードが構成されたところで、FQDN（YOUR_PROJECT_ID は実際のプロジェクト ID で置き換えます）と設定済みの ENDPOINTS_KEY 環境変数を使用してサンプル API にリクエストを送信します。

• Linux または Mac OS の場合:

  curl --request POST \
      --header "content-type:application/json" \
      --data '{"message":"hello world"}' \
      "http://echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog:80/echo?key=${ENDPOINTS_KEY}"

• Windows PowerShell の場合:

  (Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' -Headers @{"content-type"="application/json"} -URI "http://echo-api.endpoints.[YOUR_PROJECT_ID].cloud.goog:80/echo?key=$Env:ENDPOINTS_KEY").Content

API のデベロッパー ポータルを作成する

Cloud Endpoints Portal を使用してデベロッパー ポータルを作成できます。デベロッパー ポータルとは、サンプル API の操作に使用できるウェブサイトです。詳細については、Cloud Endpoints Portal の概要をご覧ください。

クリーンアップ

このチュートリアルで使用したリソースについて、Google Cloud アカウントに課金されないようにするには、リソースを含むプロジェクトを削除するか、プロジェクトを維持して個々のリソースを削除します。

このチュートリアルで使用したサービスを停止するには、API と API インスタンスを削除するをご覧ください。

次のステップ

• Docker イメージを作成する方法を学習する。
• Kubernetes にエンドポイントをデプロイする方法を学習する。
• API を他のデベロッパーと共有する。
• 認証について詳しく学ぶ。
• コミュニティ サポート オプションについて学習する。
• GKE デプロイのトラブルシューティングを行う。