ESPv2 を使用したマネージド インスタンス グループ（MIG）用の Cloud Endpoints のスタートガイド

OpenAPI   |  gRPC

このチュートリアルでは、マネージド インスタンス グループ（MIG）のビルド済み Docker コンテナで動作するサンプル API と Extensible Service Proxy V2（ESPv2）を構成してデプロイする方法を説明します。

サンプルコードの REST API は、OpenAPI 仕様に従って作成されています。このチュートリアルでは、API キーを作成して API へのリクエストで使用する方法も説明します。

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

目標

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

1. Google Cloud プロジェクトを設定します。始める前にをご覧ください。
2. サンプルコードをダウンロードします。サンプルコードを取得するをご覧ください。
3. Endpoints の構成に使用する openapi.yaml ファイルを構成します。Endpoints を構成するをご覧ください。
4. Endpoints 構成をデプロイして Endpoints サービスを作成します。Endpoints 構成をデプロイするをご覧ください。
5. API と ESPv2 をマネージド インスタンス グループ（MIG）のバックエンドでデプロイします。API バックエンドをデプロイするをご覧ください。
6. IP アドレスを使用して API にリクエストを送信します。IP アドレスを使用してリクエストを送信するをご覧ください。
7. サンプル API の DNS レコードを構成します。Endpoints の DNS を構成するをご覧ください。
8. 完全修飾ドメイン名を使用して API にリクエストを送信します。FQDN を使用してリクエストを送信するをご覧ください。
9. API のアクティビティを追跡します。API の活動を追跡するをご覧ください。
10. Google Cloud アカウントに課金されないようにします。クリーンアップをご覧ください。

費用

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

• Compute Engine
• Endpoints

料金計算ツールを使うと、予想使用量に基づいて費用の見積もりを生成できます。

新規の Google Cloud ユーザーは無料トライアルをご利用いただける場合があります。

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

始める前に

始める前に

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

1. 後で必要になるため、プロジェクト ID をメモしておきます。

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

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

   gcloud components update

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

   gcloud auth login

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

   gcloud config set project YOUR_PROJECT_ID

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

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

サンプルコードのダウンロード

サンプルコードをローカルマシンにダウンロードします。

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 2.0 または OpenAPI 3.x に基づいて、アプリの surface と認証要件を記述する OpenAPI ドキュメントを用意する必要があります。詳細については、サポートされている OpenAPI バージョンをご覧ください。

また、ESPv2 がアプリを呼び出すために必要な情報を取得できるよう、このドキュメントには各アプリの URL を設定した Google 固有のフィールドも追加する必要があります。OpenAPI を初めて使用する場合は、OpenAPI の概要で詳細をご覧ください。

OpenAPI 2.0

OpenAPI 2.0 仕様を使用して Endpoints を構成するには、ダウンロードしたサンプルコードの endpoints/getting-started ディレクトリにある openapi.yaml ファイルを使用します。

OpenAPI 2.0 仕様の内容は次のようになります。

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"

consumes:
  - "application/json"
produces:
  - "application/json"

schemes:
# Uncomment the next line if you configure SSL for this API.
# - "https"
  - "http"

paths:
  /echo:
    post:
      description: "Echo back a given message."
      operationId: "echo"
      produces:
        - "application/json"
      responses:
        200:
          description: "Echo"
          schema:
            $ref: "#/definitions/echoMessage"
      parameters:
        -
          description: "Message to echo"
          in: body
          name: message
          required: true
          schema:
            $ref: "#/definitions/echoMessage"
      security:
        - api_key: []
  /auth/info/googlejwt:
    get:
      description: "Returns the requests' authentication information."
      operationId: "auth_info_google_jwt"
      produces:
        - "application/json"
      responses:
        200:
          description: "Authenication info."
          schema:
            $ref: "#/definitions/authInfoResponse"
      security:
        - api_key: []
          google_jwt: []
  /auth/info/googleidtoken:
    get:
      description: "Returns the requests' authentication information."
      operationId: "authInfoGoogleIdToken"
      produces:
        - "application/json"
      responses:
        200:
          description: "Authentication info."
          schema:
            $ref: "#/definitions/authInfoResponse"
      security:
        - api_key: []
          google_id_token: []

definitions:
  echoMessage:
    type: "object"
    properties:
      message:
        type: "string"
  authInfoResponse:
    properties:
      id:
        type: "string"
      email:
        type: "string"

securityDefinitions:
  # This section configures basic authentication with an API key.
  api_key:
    type: "apiKey"
    name: "key"
    in: "query"

  # This section configures authentication using Google API Service Accounts
  # to sign a json web token. This is mostly used for server-to-server
  # communication.
  google_jwt:
    authorizationUrl: ""
    flow: "implicit"
    type: "oauth2"
    # This must match the 'iss' field in the JWT.
    x-google-issuer: "jwt-client.endpoints.sample.google.com"
    # Update this with your service account's email address.
    x-google-jwks_uri: "https://www.googleapis.com/service_accounts/v1/jwk/YOUR_SERVICE_ACCOUNT_EMAIL"
    # This must match the "aud" field in the JWT. You can add multiple
    # audiences to accept JWTs from multiple clients.
    x-google-audiences: "echo.endpoints.sample.google.com"
  # This section configures authentication using Google OAuth2 ID Tokens.
  # ID Tokens can be obtained using OAuth2 clients, and can be used to access
  # your API on behalf of a particular user.

  google_id_token:
    authorizationUrl: ""
    flow: "implicit"
    type: "oauth2"
    x-google-issuer: "https://accounts.google.com"
    x-google-jwks_uri: "https://www.googleapis.com/oauth2/v3/certs"
    # Your OAuth2 client's Client ID must be added here. You can add
    # multiple client IDs to accept tokens from multiple clients.
    x-google-audiences: "YOUR_CLIENT_ID"

OpenAPI 3.x

OpenAPI 3.x 仕様を使用して Endpoints を構成するには、ダウンロードしたサンプルコードの endpoints/getting-started ディレクトリにある openapi.yaml ファイルの内容を置き換えます。

1. テキスト エディタで openapi.yaml を開き、内容を次のように置き換えます。

   openapi: 3.0.4
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   servers:
     - url: "http://echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
       x-google-endpoint: {}
   
   paths:
     "/echo":
       post:
         description: "Echo back a given message."
         operationId: "echo"
         requestBody:
           description: "Message to echo"
           required: true
           content:
             "application/json":
               schema:
                 $ref: "#/components/schemas/echoMessage"
         responses:
           '200':
             description: "Echo"
             content:
               "application/json":
                 schema:
                   $ref: "#/components/schemas/echoMessage"
         security:
           - api_key: []
   
     "/auth/info/googlejwt":
       get:
         description: "Returns the requests' authentication information."
         operationId: "auth_info_google_jwt"
         responses:
           '200':
             description: "Authentication info."
             content:
               "application/json":
                 schema:
                   $ref: "#/components/schemas/authInfoResponse"
         security:
           - api_key: []
             google_jwt: []
   
     "/auth/info/googleidtoken":
       get:
         description: "Returns the requests' authentication information."
         operationId: "authInfoGoogleIdToken"
         responses:
           '200':
             description: "Authentication info."
             content:
               "application/json":
                 schema:
                   $ref: "#/components/schemas/authInfoResponse"
         security:
           - api_key: []
             google_id_token: []
   
   components:
     schemas:
       echoMessage:
         type: "object"
         properties:
           message:
             type: "string"
       authInfoResponse:
         properties:
           id:
             type: "string"
           email:
             type: "string"
   
     securitySchemes:
       api_key:
         type: "apiKey"
         name: "key"
         in: "query"
   
       google_jwt:
         type: "oauth2"
         flows:
           implicit:
             authorizationUrl: ""
             scopes: {}
         x-google-auth:
           issuer: "jwt-client.endpoints.sample.google.com"
           jwksUri: "https://www.googleapis.com/service_accounts/v1/jwk/YOUR_SERVICE_ACCOUNT_EMAIL"
           audiences: "echo.endpoints.sample.google.com"
   
       google_id_token:
         type: "oauth2"
         flows:
           implicit:
             authorizationUrl: ""
             scopes: {}
         x-google-auth:
           issuer: "https://accounts.google.com"
           jwksUri: "https://www.googleapis.com/oauth2/v3/certs"
           audiences:
             - "YOUR_CLIENT_ID"

2. openapi.yaml の新しい内容を保存します。

注: サンプル openapi.yaml ファイルには、このチュートリアルでは不要な認証を構成するためのセクションが含まれています。YOUR_SERVICE_ACCOUNT_EMAIL と YOUR_CLIENT_ID の行を構成する必要はありません。

このチュートリアルでは、サービス名を構成できる OpenAPI 仕様の Google 固有の拡張機能を使用します。サービス名を指定する方法は、使用している OpenAPI 仕様のバージョンによって異なります。

OpenAPI 2.0

host フィールドを使用して、サービス名を指定します。

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

Endpoints を構成するには:

1. openapi.yaml ファイルを開きます。
2. host フィールドで、YOUR_PROJECT_ID を Google Cloud プロジェクト ID に置き換えます。
3. openapi.yaml ファイルを保存します。

OpenAPI 3.x

サービス名を指定するには、servers オブジェクトの url フィールドを使用します。

servers:
- url: https://echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog
  x-google-endpoint: {}

Endpoints を構成するには:

1. openapi.yaml ファイルを開きます。
2. openapi.yaml ファイルに host フィールドがある場合は、削除します。
3. 次に示すように、servers オブジェクトを追加します。
4. url フィールドで、YOUR_PROJECT_ID を Google Cloud プロジェクト ID に置き換えます。
5. openapi.yaml ファイルを保存します。

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

Endpoints 構成をデプロイする

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

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

1. openapi.yaml 構成ファイルがあるディレクトリにいることを確認します。
2. 構成をアップロードしてマネージド サービスを作成します。

   gcloud endpoints services deploy openapi.yaml
   

gcloud コマンドが Service Management API を呼び出して、openapi.yaml ファイルの host フィールドまたは servers.url フィールドで指定した名前のマネージド サービスを作成します。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 と ESP を使用するには、少なくとも次の Google サービスの有効化が必要です。

名前	タイトル
servicemanagement.googleapis.com	Service Management API
servicecontrol.googleapis.com	Service Control API

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

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

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

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

gcloud services list

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

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

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

gcloud services enable ENDPOINTS_SERVICE_NAME

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

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

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

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

API バックエンドのデプロイ

インスタンス テンプレートの作成

VM インスタンスのグループの作成に使用するテンプレートを作成します。テンプレートから作成された各インスタンスにより、ESPv2 とバックエンド アプリケーション サーバーが起動されます。

1. Google Cloud コンソールで、[インスタンス テンプレート] ページに移動します。

   [インスタンス テンプレート] に移動

2. [インスタンス テンプレートを作成] をクリックします。

3. [名前] に「load-balancing-espv2-template」と入力します。

4. [マシンの構成] で、[マシンタイプ] を e2-micro に設定します。

5. [ブートディスク] で、[イメージ] を Container Optimized OS stable version に設定します。

6. [ファイアウォール] で、[HTTP トラフィックを許可する] をオンにします。

7. [管理、セキュリティ、ディスク、ネットワーク、単一テナンシー] をクリックして、詳細設定を表示します。

8. [管理] タブをクリックします。[自動化] に、次の起動スクリプトを入力します。ENDPOINTS_SERVICE_NAME を必ず更新してください。

   sudo docker network create --driver bridge esp_net
   sudo docker run \
     --detach \
     --name=echo \
     --net=esp_net \
     gcr.io/google-samples/echo-python:1.0
   sudo docker run \
     --detach \
     --name=esp \
     --publish=80:9000 \
     --net=esp_net \
     gcr.io/endpoints-release/endpoints-runtime:2 \
     --service=ENDPOINTS_SERVICE_NAME \
     --rollout_strategy=managed \
     --listener_port=9000 \
     --healthz=/healthz \
     --backend=echo:8080
   

   このスクリプトは、インスタンスの起動時に、echo アプリケーション サーバーと ESPv2 プロキシ サーバーを取得してインストールした後、起動します。

9. [作成] をクリックします。

続行する前に、テンプレートの作成が完了するまでお待ちください。

リージョン マネージド インスタンス グループを作成する

アプリケーションを実行するには、インスタンス テンプレートを使用してリージョン マネージド インスタンス グループを作成します。

1. Google Cloud コンソールで、[インスタンス グループ] ページに移動します。

   [インスタンス グループ] に移動

2. [インスタンス グループを作成] をクリックします。

3. [名前] に「load-balancing-espv2-group」と入力します。

4. [ロケーション] で、[複数のゾーン] を選択します。

   ヒント: ゾーンの停止などの極端なケースでもアプリケーションの可用性を確保するため、Compute Engine のアプリケーションを複数のゾーンに分散することをおすすめします。

5. [リージョン] で、us-central1 を選択します。

6. [ゾーンを設定] プルダウン メニューをクリックして、[ゾーン] を表示します。次のゾーンを選択します。

   • us-central1-b
   • us-central1-c
   • us-central1-f

7. [インスタンス テンプレート] で load-balancing-espv2-template を選択します。

8. [自動スケーリング] で [自動スケーリングしない] を選択します。

9. [インスタンス数] を「3」に設定します。

   ヒント: リージョン マネージド インスタンス グループを作成する際に、Compute Engine で十分な数のインスタンスをプロビジョニングして、1 つのゾーンのすべてのインスタンスが使用できなくなっても、残りのインスタンスが必要最小限のインスタンス数を満たすようにすることをおすすめします。ただし、必要以上にインスタンスをプロビジョニングすると、余分な費用が発生する可能性があります。詳細については、可用性を確保できるようにインスタンス グループのサイズを選択するをご覧ください。

10. [インスタンスの再配布] で、[オン] を選択します。

11. [自動修復] と [ヘルスチェック] で、[ヘルスチェックをしない ] を選択します。

12. [作成] をクリックします。[インスタンス グループ] ページにリダイレクトされます。

    注: グループ内のすべてのインスタンスが実行されてウェブ アプリケーションを表示する準備ができるまで、数分かかることがあります。

ロードバランサを作成

このセクションでは、HTTP トラフィックをインスタンス グループに振り分けるグローバル ロードバランサの作成に必要な手順を説明します。

このロードバランサは、フロントエンドを使用して着信トラフィックを受信し、バックエンドを使用してこのトラフィックを正常なインスタンスに配信します。ロードバランサは複数のコンポーネントで構成されるため、ロードバランサを作成するタスクは以下のステップに分かれます。

• バックエンドの構成
• フロントエンドの構成
• 確認と完了

これらのステップをすべて完了して、ロードバランサを作成します。

1. Google Cloud コンソールで、[ロードバランサの作成] ページに移動します。

   [ロードバランサの作成] に移動

2. [アプリケーション ロードバランサ（HTTP/S）] セクションで、[構成を開始] をクリックします。

3. [インターネット接続または内部専用] で、[インターネットから自分の VM へ] を選択します。次に、[続行] をクリックします。

4. ロードバランサの [名前] に「espv2-load-balancer」と入力します。

バックエンドの構成

1. [グローバル外部アプリケーション ロードバランサの作成] ページの左パネルで、[バックエンドの構成] をクリックします。
2. [バックエンド サービスとバックエンド バケットの作成または選択] をクリックして、プルダウン メニューを開きます。[バックエンド サービス] をクリックし、[バックエンド サービスを作成] をクリックします。
3. 新しいウィンドウで、バックエンド アプリケーションの [名前] に「espv2-backend」と入力します。
4. [インスタンス グループ] を load-balancing-espv2-group に設定します。
5. [ポート番号] を 80 に設定します。これにより、ロードバランサとインスタンス グループ間の HTTP トラフィックを許可することができます。
6. [分散モード] で、[使用率] を選択します。
7. [完了] をクリックすると、バックエンドが作成されます。

8. ロードバランサのバックエンドのヘルスチェックを作成します。

   上級者向けのヒント: ヘルスチェックは負荷分散と自動修復の両方で使用されますが、目的は異なります。

   • ロード バランシングのヘルスチェックは、応答しないインスタンスを検出してトラフィックの配信先から除外するために使用されます。
   • 自動修復のヘルスチェックは、失敗したインスタンスの検出と再作成に使用されます。

   負荷分散と自動修復には、別々のヘルスチェックを使用します。これらのサービスに同じヘルスチェックを使用すると、応答しないインスタンスと失敗したインスタンスが区別できなくなり、ユーザーに余計なレイテンシや使用不能といった不便を強いることになります。詳細については、ヘルスチェックのコンセプトをご覧ください。

   1. [ヘルスチェック] で、プルダウン メニューから [ヘルスチェックを作成]（または [別のヘルスチェックを作成]）をクリックします。新しいウィンドウが開きます。
   2. 新しいウィンドウで、[名前] に「espv2-load-balancer-check」と入力します。
   3. [プロトコル] を HTTP に設定します。
   4. [ポート] に「80」と入力します。
   5. このチュートリアルでは、[リクエストパス] を /healthz に設定します。これは、ESPv2 が応答するように設定されているパスです。

   6. ヘルス条件を次のように設定します。

      1. [チェック間隔] を 3 秒に設定します。これは、プローブを開始してから次のブローブを開始するまでの時間です。
      2. [タイムアウト] を 3 秒に設定します。これは、 Google Cloud でプローブに対するレスポンスを待ち受ける時間です。この値は、チェック間隔で設定した数値以下にする必要があります。
      3. [正常しきい値] を [2 回連続して成功] に設定します。これは、プローブが連続で成功するとインスタンスが正常であると判断される回数です。
      4. [異常しきい値] を [2 回連続して失敗] に設定します。これは、プローブが連続で失敗するとインスタンスに異常があると判断される回数です。

      上級者向けのヒント: アプリケーションのチェック間隔とタイムアウトの値の調整方法については、ヘルスチェックの仕組みをご覧ください。アプリケーションの正常しきい値と異常しきい値の値を調整するには、次の条件を使用します。

      • より高速なインスタンスを使用できるにもかかわらずトラフィックが高レイテンシのインスタンスに配信されている場合は、ヘルスチェックを厳格にしてトラフィックのしきい値を下げます。
      • トラフィックが低レイテンシのインスタンスに配信されていない場合は、ヘルスチェックを緩和してトラフィックのしきい値を上げます。

      レイテンシの最適化と測定の詳細については、負荷分散を使用したアプリケーション レイテンシの最適化をご覧ください。

   7. [保存して次へ] をクリックすると、ヘルスチェックが作成されます。

9. [作成] をクリックすると、バックエンド サービスが作成されます。

フロントエンドの構成

1. [グローバル外部アプリケーション ロードバランサの作成] ページの左パネルで、[フロントエンドの構成] をクリックします。
2. [フロントエンドの設定] ページで、[名前] に「espv2-ipv4-frontend」と入力します。
3. [プロトコル] を HTTP に設定します。
4. [ポート] を 80 に設定します。
5. [完了] をクリックすると、フロントエンドが作成されます。

確認と完了

1. ロードバランサを作成する前に、負荷分散設定を確認します。

   1. [グローバル外部アプリケーション ロードバランサを作成] ページの左パネルで、[確認と完了] をクリックします。

   2. [確認と完了] ページで、バックエンドが次のように設定されていることを確認します。

      • [バックエンド サービス] が espv2-backend。
      • [エンドポイント プロトコル] が HTTP。
      • [ヘルスチェック] が espv2-load-balancer-check。
      • [インスタンス グループ] が load-balancing-espv2-group。

   3. 同じページで、フロントエンドが使用する IP アドレスのプロトコルが HTTP になっていることを確認します。

2. [Create global external Application Load Balancer] ページの左パネルで [作成] をクリックすると、ロードバランサの作成が完了します。

   ロードバランサの作成が完了するまでに数分待機することが必要な場合があります。

3. ロードバランサが作成されたら、[ロードバランサ] ページでその IP アドレスを見つけます。

   [ロードバランサ] に移動

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

サンプル API と ESPv2 がデプロイされたバックエンドで動作したら、ローカルマシンから 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 エンジニアから回答を受け取ることができます。

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 を構成するには:

OpenAPI 2.0

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 3.x

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

   servers:
     - url: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
       x-google-endpoint:
         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 ファイルは次のように構成されていると仮定します。

OpenAPI 2.0

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"

OpenAPI 3.x

servers:
  - url: "echo-api.endpoints.example-project-12345.cloud.goog"
    x-google-endpoint:
      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 のアクティビティを追跡する

API の活動を追跡するには:

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

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

   
   グラフにリクエストが反映されるまでに、しばらく時間がかかる場合があります。
2. [ログ エクスプローラ] ページで、API のリクエストログを確認します。
   

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

クリーンアップ

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

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

   gcloud auth login
   

2. 次のコマンドを入力して、 Google Cloudプロジェクトのプロジェクト ID を表示します。

   gcloud projects list
   

3. 前の手順で取得したプロジェクト ID のうち、アプリケーションが存在するプロジェクトの ID にデフォルトのGoogle Cloud プロジェクトを設定します。

   gcloud config set project [YOUR_PROJECT_ID]
   

4. Google Cloud プロジェクト内のすべてのマネージド サービスの名前を取得します。

   gcloud endpoints services list
   

5. Service Management からサービスを削除します。SERVICE_NAME は、削除するサービスの名前に置き換えます。

   gcloud endpoints services delete SERVICE_NAME
   

   gcloud endpoints services delete コマンドを実行しても、マネージド サービスはすぐに削除されません。マネージド サービスは 30 日間無効になり、その間に必要に応じてサービスを復元できます。30 日後、マネージド サービスは完全に削除されます。

6. [ロードバランサ] ページに移動します。

   [ロードバランサ] に移動

   バックエンド サービス espv2-backend とヘルスチェック espv2-load-balancer-check とともに、ロードバランサ espv2-load-balancer を削除します。

7. [インスタンス グループ] ページに移動します。

   [インスタンス グループ] に移動

   load-balancing-espv2-group を削除します

8. [インスタンス テンプレート] ページに移動します。

   [インスタンス テンプレート] に移動

   load-balancing-espv2-template を削除します。

次のステップ

• API を他のデベロッパーと共有する
• 認証について詳しく学習する
• コミュニティ サポート オプションについて学習する