本頁面由 Cloud Translation API 翻譯而成。

透過 ESPv2 開始使用 GKE 適用的 Cloud Endpoints

OpenAPI | gRPC

本教學課程說明如何設定範例 API 和可擴充服務 Proxy V2 (ESPv2)，並部署至 Google Kubernetes Engine (GKE) 叢集。

本文使用 OpenAPI 規範說明範例程式碼的 REST API。本教學課程也會說明如何建立 API 金鑰，以及如何用於向 API 傳送要求。

本教學課程使用範例程式碼與 ESPv2 的預先建構容器映像檔，這些映像檔儲存在 Artifact Registry 中。

如需 Cloud Endpoints 的總覽資訊，請參閱關於 Endpoints 和 Endpoints 架構。

目標

在逐步進行本教學課程時，請使用以下高階工作清單。您必須完成第 1 部分內的所有工作，才能成功傳送要求至 API。

第 1 部分

設定 Google Cloud 專案。請參閱「事前準備」。
在 GKE 上建立容器叢集，請參閱建立容器叢集一節。
安裝及設定用於教學課程的軟體，請參閱安裝並設定所需的軟體一節。
下載範例程式碼，請參閱取得範例程式碼。
建立用來設定 Cloud Endpoints 的 openapi.yaml 檔案，請參閱設定 Endpoints 一節。
部署 Endpoints 設定以建立 Endpoints 服務。請參閱部署 Endpoints 設定一節。
將 API 和 ESPv2 部署至叢集。請參閱部署 API 後端一節。
取得叢集的 IP 位址，請參閱取得叢集的外部 IP 位址一節。
使用 IP 位址傳送要求至 API。請參閱使用 IP 位址傳送要求一節。
追蹤 API 活動。請參閱追蹤 API 活動一節。

第 2 部分

為範例 API 設定 DNS 記錄，請參閱為 Endpoints 設定 DNS 一節。
使用完整的網域名稱將要求傳送至 API，請參閱使用 FQDN 傳送要求一節。

清除

完成本課程時，請參閱「清除所用資源」，以免系統向您的 Google Cloud 帳戶收取相關費用。

費用

在本文件中，您會使用 Google Cloud的下列計費元件：

您可以使用 Pricing Calculator 根據預測用量產生預估費用。新 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.

Go to project selector

Make sure 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.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

記下 Google Cloud 專案 ID，後續步驟將會用到。

建立容器叢集

您必須在 GKE 中建立容器叢集，才能執行範例 API 後端程式碼。叢集需要IP 別名才能使用容器原生負載平衡。如要為範例 API 建立含有 IP 別名的容器叢集，請按照下列指示操作：

gcloud container clusters create espv2-demo-cluster \
    --enable-ip-alias \
    --create-subnetwork="" \
    --network=default \
    --zone=us-central1-a

上述範例指令會建立一個名為 espv2-demo-cluster 的叢集，而 us-central1-a 區域含有一個自動佈建的子網路。

記下叢集名稱與區域，以便用來向容器叢集驗證 kubectl。

安裝並設定所需的軟體

在本教學課程中，您將安裝 gcloud CLI，以便使用 Google Cloud CLI 管理專案。您會使用 kubectl 對 GKE 叢集執行指令。另外，您也必須備妥測試 API 的方法。

在後續程序中，如果您已安裝所需的軟體，請繼續進行下一步驟。

安裝並設定所需的軟體：

您需要一個可以將要求傳送至範例 API 的應用程式。
- Linux 和 macOS 使用者：本教學課程提供了使用 curl 的範例，這項工具通常已預先安裝於您的作業系統。如果您尚未安裝 curl，可以前往 curl 的版本與下載頁面下載這項工具。
- Windows 使用者：本教學課程提供了使用 Invoke-WebRequest 的範例，PowerShell 3.0 以上版本均支援這項工具。
安裝並初始化 gcloud CLI。
更新 gcloud CLI 並安裝 Endpoints 元件：
```
gcloud components update
```
確認 Google Cloud CLI (gcloud) 已取得授權，可存取您在 Google Cloud上的資料與服務：
```
gcloud auth login
```
在開啟的新瀏覽器分頁中選取一個帳戶。
將預設專案設為您的專案 ID：
```
gcloud config set project YOUR_PROJECT_ID
```
將 YOUR_PROJECT_ID 替換為專案 ID。如果您有其他 Google Cloud 專案，而且想要使用 gcloud 加以管理，請參閱「管理 gcloud CLI 設定」。
安裝 kubectl。
```
gcloud components install kubectl
```
取得新的使用者憑證，以便用於應用程式預設憑證。您必須取得使用者憑證，才能為 kubectl 提供授權。
```
gcloud auth application-default login
```
在開啟的新瀏覽器分頁中選取一個帳戶。

下載範例程式碼

為協助您快速完成設定並開始使用，我們提供多種語言的程式碼範例。如要將範例程式碼下載至本機電腦，請按照下列指示操作：

Java

如何複製或下載範例 API：

將範例應用程式存放區複製到您的本機電腦：
```
git clone https://github.com/GoogleCloudPlatform/java-docs-samples
```
或者，您也可以選擇下載範例 ZIP 檔案，然後再解壓縮。

前往包含範例程式碼的目錄：

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

Python

如何複製或下載範例 API：

將範例應用程式存放區複製到您的本機電腦：
```
git clone https://github.com/GoogleCloudPlatform/python-docs-samples
```
或者，您也可以選擇下載範例 ZIP 檔案，然後再解壓縮。

前往包含範例程式碼的目錄：

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

如何複製或下載範例 API：

確定您已設定 GOPATH 環境變數。

將範例應用程式存放區複製到您的本機電腦：

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

前往包含範例程式碼的目錄：

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

PHP

如何複製或下載範例 API：

將範例應用程式存放區複製到您的本機電腦：
```
git clone https://github.com/GoogleCloudPlatform/php-docs-samples
```
或者，您也可以選擇下載範例 ZIP 檔案，然後再解壓縮。

前往包含範例程式碼的目錄：

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

Ruby

如何複製或下載範例 API：

將範例應用程式存放區複製到您的本機電腦：
```
git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples
```
或者，您也可以選擇下載範例 ZIP 檔案，然後再解壓縮。

前往包含範例程式碼的目錄：

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

NodeJS

如何複製或下載範例 API：

將範例應用程式存放區複製到您的本機電腦：
```
git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples
```
或者，您也可以選擇下載範例 ZIP 檔案，然後再解壓縮。

前往包含範例程式碼的目錄：

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

設定 Endpoints

範例程式碼中包含以 OpenAPI 規格 v2.0 為基礎的 OpenAPI 設定檔 openapi.yaml。如要設定 Endpoints：

在範例程式碼目錄中開啟 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"

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 是一種各語言通用的規範。為求方便，相同的 openapi.yaml 檔案皆位於每個語言 GitHub 存放區的 getting-started 範例中。

將 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 設定：

確認您位於 endpoints/getting-started 目錄。

上傳設定並建立代管服務：

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」 >「Services」(服務) 頁面中查看 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 之類的第三方應用程式，而其中未包含這些服務。
您已將 Endpoints 設定部署至現有Google Cloud 專案，但在專案中已明確停用這些服務。

使用下列指令，確認已啟用必要服務：

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」頁面。Service name 欄下方會列出可能的 ENDPOINTS_SERVICE_NAME 清單。
針對 OpenAPI，ENDPOINTS_SERVICE_NAME 是您在 OpenAPI 規格 host 欄位中指定的值。針對 gRPC，ENDPOINTS_SERVICE_NAME 是您在 gRPC Endpoints 設定的 name 欄位中指定的值。

如要進一步瞭解 gcloud 指令，請參閱 gcloud 服務。

部署 API 後端

您目前已將 OpenAPI 文件部署至 Service Management，但尚未部署為 API 後端提供服務的程式碼。本節會逐步引導您針對 API 範例和 ESPv2，將預先建構的容器部署至叢集。

檢查必要權限

ESP 和 ESPv2 會呼叫 Google 服務，並使用 IAM 驗證呼叫身分是否具備足夠的權限，可存取所使用的 IAM 資源。呼叫身分是部署 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，後者會使用 Endpoints 服務設定。端點服務設定是 IAM 資源，ESP 和 ESPv2 需要服務控制器角色才能存取。

IAM 角色是在端點服務設定中，而非在專案中。一個專案可以有多個端點服務設定。

使用下列 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 和 ESPv2 部署至叢集。如何將容器部署至叢集：

取得叢集憑證，並提供給 kubectl：
```
    gcloud container clusters get-credentials NAME --zone ZONE
    
```
將 NAME 替換為叢集名稱，並以叢集區域取代 ZONE。

將 Kubernetes 服務部署至 GKE 叢集。Kubernetes 服務會導入 API。git clone 這個 repo，cd getting-started/ 到資料夾，然後編輯 Kubernetes 設定檔 LANG-deployment.yaml，並將 ESPv2 啟動選項中的 SERVICE_NAME 替換為您的服務名稱。

Java

- name: esp
  image: gcr.io/endpoints-release/endpoints-runtime:2
  args: [
    "--listener_port=8081",
    "--backend=127.0.0.1:8080",
    "--service=SERVICE_NAME",
    "--rollout_strategy=managed",
    "--healthz=/healthz",
  ]
  readinessProbe:
    httpGet:
      path: /healthz
      port: 8081

Python

- name: esp
  image: gcr.io/endpoints-release/endpoints-runtime:2
  args: [
    "--listener_port=8081",
    "--backend=http://127.0.0.1:8080",
    "--service=SERVICE_NAME",
    "--rollout_strategy=managed",
    "--healthz=/healthz",
  ]
  readinessProbe:
    httpGet:
      path: /healthz
      port: 8081

- name: esp
  image: gcr.io/endpoints-release/endpoints-runtime:2
  args: [
    "--listener_port", "8081",
    "--backend", "127.0.0.1:8080",
    "--service", "SERVICE_NAME",
    "--rollout_strategy", "managed",
    "--healthz=/healthz",
  ]
  readinessProbe:
    httpGet:
      path: /healthz
      port: 8081

PHP

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

Ruby

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

NodeJS

- name: esp
  image: gcr.io/endpoints-release/endpoints-runtime:2
  args: [
    "--listener_port", "8081",
    "--backend", "127.0.0.1:8080",
    "--service", "SERVICE_NAME",
    "--rollout_strategy", "managed",
    "--healthz=/healthz",
  ]
  readinessProbe:
    httpGet:
      path: /healthz
      port: 8081

例如：

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

--rollout_strategy=managed 選項可將 ESPv2 設為使用最新部署的服務設定。指定此選項時，在您部署新服務設定後一分鐘內，ESPv2 會偵測到變更並自動開始使用新設定。建議您指定此選項，而非讓 ESPv2 使用特定的設定 ID。如要進一步瞭解使用的其他 ESPv2 選項，請參閱 ESPv2 啟動選項。

如果您在同一個 Google Cloud 專案中執行大量 (超過 100 個) Endpoints，建議您為容器掛載服務設定，而非使用 --rollout_strategy=managed 標記從 Service Management API 提取服務設定。Service Management API 有預設配額。如果大量 Endpoints 使用 --rollout_strategy=managed，所有 Endpoints 都會輪詢最新的服務設定。車隊可能會超出配額，導致服務設定更新失敗。請按照下列步驟掛載服務設定。

下載服務設定 JSON 設定檔。

curl -o "/tmp/service_config.json" -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  "https://servicemanagement.googleapis.com/v1/services/SERVICE/configs/CONFIG_ID?view=FULL"

使用 JSON 設定檔建立 Kubernetes 設定對應資源。

kubectl create configmap service-config-configmap \
  --from-file=service_config.json:/tmp/service_config.json

將設定資源對應圖掛載至容器，並使用「--service_config_path」標記指定設定檔的路徑。

例如：

  containers:
  - args:
    - --listener_port=8081
    - --backend=http://127.0.0.1:8080
    - --service_json_path=/etc/espv2_config/service_config.json
    - --healthz=/healthz
    image: gcr.io/endpoints-release/endpoints-runtime:2
    name: esp
    ports:
    - containerPort: 8081
      protocol: TCP
    volumeMounts:
    - mountPath: /etc/espv2_config
      name: service-config-volume
  volumes:
  - configMap:
      defaultMode: 420
      name: service-config-configmap
    name: service-config-volume

使用 kubectl apply 指令啟動 Kubernetes 服務：

Java

kubectl apply -f java-deployment.yaml

Python

kubectl apply -f python-deployment.yaml

kubectl apply -f golang-deployment.yaml

PHP

kubectl apply -f php-deployment.yaml

Ruby

kubectl apply -f ruby-deployment.yaml

NodeJS

kubectl apply -f nodejs-deployment.yaml

如果您收到錯誤訊息，請參閱GKE 中的 Cloud Endpoints 疑難排解一文。詳情請參閱「部署 API 後端」一文。

取得叢集的外部 IP 位址

如要將要求傳送至 API，您必須取得服務的外部 IP。在容器中啟動服務之後，系統可能需要幾分鐘的時間才能備妥外部 IP 位址。

查看外部 IP 位址：
```
kubectl get ingress
```
記下 EXTERNAL-IP 的值。將要求傳送至範例 API 時，您必須使用這組 IP 位址。

使用 IP 位址傳送要求

服務已在容器叢集中運作，您也取得了外部 IP 位址，因此可以將要求傳送至 API。

建立 API 金鑰並設定環境變數

範例程式碼需要 API 金鑰。為了簡化要求，請設定 API 金鑰的環境變數。

在您用於 API 的 Google Cloud 專案中，在 API 憑證頁面上建立 API 金鑰。如果您想在不同的 Google Cloud 專案中建立 API 金鑰，請參閱在 Google Cloud 專案中啟用 API。

前往憑證頁面
按一下 [Create credentials] (建立憑證)，然後選取 [API key] (API 金鑰)。
將金鑰複製到剪貼簿。
按一下 [Close] (關閉)。
在本機電腦中貼上 API 金鑰，以便指派給環境變數：
- 在 Linux 或 macOS 中：export ENDPOINTS_KEY=AIza...
- 在 Windows PowerShell 中：$Env:ENDPOINTS_KEY="AIza..."

傳送要求

Linux 或 mac OS

使用 curl，透過先前設定的 ENDPOINTS_KEY 環境變數傳送 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

使用 Invoke-WebRequest，透過先前設定的 ENDPOINTS_KEY 環境變數傳送 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

在上述範例中，前兩行的結尾為倒引號。當您將範例貼到 PowerShell 中時，請確保倒引號後面沒有空格。如要瞭解範例要求中使用的選項，請參閱 Microsoft 說明文件中的 Invoke-WebRequest。

第三方應用程式

您可以使用諸如 Chrome 瀏覽器擴充功能 Postman 等第三方應用程式，傳送要求：

選取 POST 做為 HTTP 動詞。
選取 content-type 鍵和 application/json 值做為標頭。
輸入以下內文：
{"message":"hello world"}
在網址中使用實際的 API 金鑰，而非環境變數。例如：
http://192.0.2.0:80/echo?key=AIza...

API 會回應您傳送的訊息，並傳回以下內容：

{
  "message": "hello world"
}

如果您未取得成功的回應，請參閱排解回應錯誤一文。

您已在 Endpoints 中部署並測試了 API！

追蹤 API 活動

如何追蹤 API 活動：

在「Endpoints」>「Services」(服務) 頁面中查看 API 的活動圖表。

前往 Endpoints 服務頁面

要求可能需要一些時間才能反映在圖表中。
在「Logs Explorer」(記錄檔探索工具) 頁面中查看您的 API 要求記錄。

前往「Logs Explorer」頁面

為 Endpoints 設定 DNS

API 的 Endpoints 服務名稱位於 .endpoints.YOUR_PROJECT_ID.cloud.goog 網域，因此您只需要略為調整 openapi.yaml 檔案的設定，即可將該網域當做完整的網域名稱 (FQDN)。這樣一來，您就能使用 echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog (而非 IP 位址) 將要求傳送至範例 API。

如何設定 Endpoints DNS：

開啟 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"
```
在 name 屬性中，將 YOUR_PROJECT_ID 替換為您的專案 ID。
在 target 屬性中，將 IP_ADDRESS 替換為您向範例 API 傳送要求時使用的 IP 位址。
將更新的 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 會建立 DNS A 記錄 echo-api.endpoints.my-project-id.cloud.goog，這個記錄會解析為目標 IP 位址 192.0.2.1。新的 DNS 設定可能需要幾分鐘才會生效。

設定 SSL

如要進一步瞭解如何設定 DNS 和安全資料傳輸層 (SSL)，請參閱「啟用 Endpoints 的安全資料傳輸層 (SSL)」一文。

使用 FQDN 傳送要求

為範例 API 設定 DNS 記錄之後，請使用 FQDN (將 YOUR_PROJECT_ID 替換為您的專案 ID) 與先前設定的 ENDPOINTS_KEY 環境變數向 API 傳送要求：

在 Linux 或 macOS 中：

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

清除所用資源

如要避免系統向您的 Google Cloud 帳戶收取本教學課程中所用資源的相關費用，請刪除含有該項資源的專案，或者保留專案但刪除個別資源。

如要瞭解如何停用本教學課程使用的服務，請參閱刪除 API 和 API 執行個體一文。

透過 ESPv2 開始使用 GKE 適用的 Cloud Endpoints 透過集合功能整理內容 你可以依據偏好儲存及分類內容。

目標

費用

事前準備

建立容器叢集

安裝並設定所需的軟體

下載範例程式碼

設定 Endpoints

部署 Endpoints 設定

檢查必要服務

部署 API 後端

檢查必要權限

新增必要的 IAM 角色：

端點服務設定

Cloud Trace

將容器部署至叢集

取得叢集的外部 IP 位址

使用 IP 位址傳送要求

建立 API 金鑰並設定環境變數

傳送要求

Linux 或 mac OS

PowerShell

第三方應用程式

追蹤 API 活動

為 Endpoints 設定 DNS

設定 SSL

使用 FQDN 傳送要求

清除所用資源

後續步驟

透過 ESPv2 開始使用 GKE 適用的 Cloud Endpoints