Mulai menggunakan Cloud Endpoints untuk Compute Engine dengan ESPv2

Tutorial ini menunjukkan cara mengonfigurasi dan men-deploy sampel API dan Extensible Service Proxy V2 (ESPv2) yang berjalan di penampung Docker bawaan di Compute Engine.

REST API kode contoh dijelaskan menggunakan spesifikasi OpenAPI. Tutorial ini juga menunjukkan cara membuat kunci API dan menggunakannya dalam permintaan ke API.

Untuk ringkasan Cloud Endpoints, lihat Tentang Endpoints dan Arsitektur Endpoints.

Tujuan

Gunakan daftar tugas tingkat tinggi berikut saat Anda mengerjakan tutorial ini. Semua tugas diperlukan agar berhasil mengirim permintaan ke API.

  1. Siapkan project Google Cloud. Lihat Sebelum memulai.
  2. Buat instance VM Compute Engine. Lihat Membuat instance Compute Engine.
  3. Download kode contoh. Lihat Mendapatkan kode contoh.
  4. Konfigurasikan file openapi.yaml, yang digunakan untuk mengonfigurasi Endpoint. Lihat Mengonfigurasi Endpoint.
  5. Deploy konfigurasi Endpoint untuk membuat layanan Endpoint. Lihat Men-deploy konfigurasi Endpoint.
  6. Deploy API dan ESPv2 di VM Compute Engine. Lihat Men-deploy backend API.
  7. Kirim permintaan ke API menggunakan alamat IP. Lihat Mengirim permintaan menggunakan alamat IP.
  8. Konfigurasikan data DNS untuk API contoh. Lihat Mengonfigurasi DNS untuk Endpoint.
  9. Kirim permintaan ke API menggunakan nama domain yang sepenuhnya memenuhi syarat. Lihat Mengirim permintaan menggunakan FQDN.
  10. Melacak aktivitas API. Lihat Melacak aktivitas API.
  11. Hindari tagihan pada akun Google Cloud Anda. Lihat Pembersihan.

Biaya

Dalam dokumen ini, Anda akan menggunakan komponen Google Cloud yang dapat ditagih berikut:

Untuk membuat perkiraan biaya berdasarkan proyeksi penggunaan Anda, gunakan kalkulator harga. Pengguna baru Google Cloud mungkin memenuhi syarat untuk mendapatkan uji coba gratis.

Setelah menyelesaikan tugas yang dijelaskan dalam dokumen ini, Anda dapat menghindari penagihan berkelanjutan dengan menghapus resource yang Anda buat. Untuk mengetahui informasi selengkapnya, lihat Pembersihan.

Sebelum memulai

  1. 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.

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

    Go to project selector

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

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

    Go to project selector

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

  6. Catat project ID karena Anda akan memerlukannya nanti.

  7. Anda memerlukan aplikasi untuk mengirim permintaan ke API contoh.

    • Pengguna Linux dan macOS: Tutorial ini memberikan contoh penggunaan curl, yang biasanya sudah diinstal sebelumnya di sistem operasi Anda. Jika tidak memiliki curl, Anda dapat mendownloadnya dari halaman curl Rilis dan download.
    • Pengguna Windows: Tutorial ini memberikan contoh penggunaan Invoke-WebRequest, yang didukung di PowerShell 3.0 dan yang lebih baru.
  8. Download Google Cloud CLI.
  9. Update gcloud CLI dan instal komponen Endpoints. 
    gcloud components update
  10. Pastikan Google Cloud CLI (gcloud) diberi otorisasi untuk mengakses data dan layanan Anda di Google Cloud: 
    gcloud auth login
     Di tab browser baru yang terbuka, pilih akun.
  11. Tetapkan project default ke project ID Anda. 
    gcloud config set project YOUR_PROJECT_ID

    Ganti YOUR_PROJECT_ID dengan project ID Anda. Jika Anda memiliki project Google Cloud lain, dan ingin menggunakan gcloud untuk mengelolanya, lihat Mengelola konfigurasi gcloud CLI.

Setelah menyelesaikan tugas yang dijelaskan dalam dokumen ini, Anda dapat menghindari penagihan berkelanjutan dengan menghapus resource yang Anda buat. Untuk mengetahui informasi selengkapnya, lihat Pembersihan.

Membuat instance Compute Engine

    Untuk membuat instance Compute Engine:

    1. In the Google Cloud console, go to the Create an instance page.

      Go to Create an instance

    2. Di bagian Firewall, pilih Izinkan traffic HTTP dan Izinkan traffic HTTPS.
    3. Untuk membuat VM, klik Create.

      4. Screenshot jendela pembuatan instance VM dengan opsi yang diperlukan

      Tunggu hingga instance memulai. Setelah siap, instance akan dicantumkan di halaman VM Instances dengan ikon status hijau.

    4. Pastikan Anda dapat terhubung ke instance VM.
      1. In the list of virtual machine instances, click SSH in the row of the instance that you want to connect to.
      2. Anda kini dapat menggunakan terminal untuk menjalankan perintah Linux di instance Debian.
      3. Masukkan exit untuk memutuskan koneksi dari instance.
    5. Catat nama instance, zona, dan alamat IP eksternal karena diperlukan nanti.

Mendownload kode contoh

Download kode contoh ke komputer lokal Anda.

Java

Untuk meng-clone atau mendownload API contoh:

  1. Clone repositori aplikasi contoh ke komputer lokal Anda: 
    git clone https://github.com/GoogleCloudPlatform/java-docs-samples

    Atau, download contoh sebagai file ZIP, lalu ekstrak.

  2. Ubah ke direktori yang berisi kode contoh: 
    cd java-docs-samples/endpoints/getting-started
Python

Untuk meng-clone atau mendownload API contoh:

  1. Clone repositori aplikasi contoh ke komputer lokal Anda: 
    git clone https://github.com/GoogleCloudPlatform/python-docs-samples

    Atau, download contoh sebagai file ZIP, lalu ekstrak.

  2. Ubah ke direktori yang berisi kode contoh: 
    cd python-docs-samples/endpoints/getting-started
Go

Untuk meng-clone atau mendownload API contoh:

  1. Pastikan variabel lingkungan GOPATH Anda telah ditetapkan.
  2. Clone repositori aplikasi contoh ke komputer lokal Anda: 
    go get -d github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started
  3. Ubah ke direktori yang berisi kode contoh: 
    cd $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started
PHP

Untuk meng-clone atau mendownload API contoh:

  1. Clone repositori aplikasi contoh ke komputer lokal Anda: 
    git clone https://github.com/GoogleCloudPlatform/php-docs-samples

    Atau, download contoh sebagai file ZIP, lalu ekstrak.

  2. Ubah ke direktori yang berisi kode contoh: 
    cd php-docs-samples/endpoints/getting-started
Ruby

Untuk meng-clone atau mendownload API contoh:

  1. Clone repositori aplikasi contoh ke komputer lokal Anda: 
    git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples

    Atau, download contoh sebagai file ZIP, lalu ekstrak.

  2. Ubah ke direktori yang berisi kode contoh: 
    cd ruby-docs-samples/endpoints/getting-started
NodeJS

Untuk meng-clone atau mendownload API contoh:

  1. Clone repositori aplikasi contoh ke komputer lokal Anda: 
    git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples

    Atau, download contoh sebagai file ZIP, lalu ekstrak.

  2. Ubah ke direktori yang berisi kode contoh: 
    cd nodejs-docs-samples/endpoints/getting-started

Mengonfigurasi Endpoint

Kode contoh menyertakan file konfigurasi OpenAPI, openapi.yaml, yang didasarkan pada Spesifikasi OpenAPI v2.0. Anda mengonfigurasi dan men-deploy openapi.yaml di komputer lokal. Untuk mengonfigurasi Endpoint:

  1. Di direktori kode contoh, buka file konfigurasi 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"

    Perhatikan hal berikut:

    • Contoh konfigurasi menampilkan baris di dekat kolom host, yang perlu Anda ubah. Untuk men-deploy file openapi.yaml ke Endpoint, dokumen OpenAPI lengkap diperlukan.
    • Contoh file openapi.yaml berisi bagian untuk mengonfigurasi autentikasi yang tidak diperlukan untuk tutorial ini. Anda tidak perlu mengonfigurasi baris dengan YOUR-SERVICE-ACCOUNT-EMAIL dan YOUR-CLIENT-ID.
    • OpenAPI adalah spesifikasi yang tidak bergantung pada bahasa. File openapi.yaml yang sama ada dalam contoh getting-started di setiap repositori GitHub bahasa untuk memudahkan.

  2. Di kolom host, ganti teks dengan nama layanan Endpoints, yang harus dalam format berikut: 
    host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"

    Ganti YOUR_PROJECT_ID dengan ID project Google Cloud Anda. Contoh:

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

Perhatikan bahwa echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog adalah nama layanan Endpoints. Ini bukan nama domain yang sepenuhnya memenuhi syarat (FQDN) yang Anda gunakan untuk mengirim permintaan ke API.

Untuk mengetahui informasi tentang kolom dalam dokumen OpenAPI yang diperlukan Endpoints, lihat Mengonfigurasi Endpoints. Setelah menyelesaikan semua langkah konfigurasi berikut sehingga Anda dapat berhasil mengirim permintaan ke API contoh menggunakan alamat IP, lihat Mengonfigurasi DNS Endpoint untuk mengetahui informasi tentang cara mengonfigurasi echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog menjadi FQDN.

Men-deploy konfigurasi Endpoint

Untuk men-deploy konfigurasi Endpoint, Anda menggunakan perintah gcloud endpoints services deploy. Perintah ini menggunakan Pengelolaan Layanan untuk membuat layanan terkelola.

Untuk men-deploy konfigurasi Endpoint:

  1. Pastikan Anda berada di direktori endpoints/getting-started.
  2. Upload konfigurasi dan buat layanan terkelola: 
    gcloud endpoints services deploy openapi.yaml

Perintah gcloud kemudian memanggil Service Management API untuk membuat layanan terkelola dengan nama yang Anda tentukan di kolom host file openapi.yaml. Pengelolaan Layanan mengonfigurasi layanan sesuai dengan setelan dalam file openapi.yaml. Saat membuat perubahan pada openapi.yaml, Anda harus men-deploy ulang file untuk mengupdate layanan Endpoints.

Saat membuat dan mengonfigurasi layanan, Pengelolaan Layanan akan menampilkan informasi ke terminal. Anda dapat mengabaikan peringatan tentang jalur dalam file openapi.yaml yang tidak memerlukan kunci API dengan aman. Setelah selesai mengonfigurasi layanan, Pengelolaan Layanan akan menampilkan pesan dengan ID konfigurasi layanan dan nama layanan, mirip dengan berikut:

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

Pada contoh sebelumnya, 2017-02-13r0 adalah ID konfigurasi layanan, dan echo-api.endpoints.example-project-12345.cloud.goog adalah layanan Endpoint. ID konfigurasi layanan terdiri dari stempel tanggal yang diikuti dengan nomor revisi. Jika Anda men-deploy file openapi.yaml lagi pada hari yang sama, nomor revisi akan bertambah di ID konfigurasi layanan. Anda dapat melihat konfigurasi layanan Endpoints di halaman Endpoints > Services di Konsol Google Cloud.

Jika Anda menerima pesan error, lihat Memecahkan masalah deployment konfigurasi Endpoints.

Memeriksa layanan yang diperlukan

Setidaknya, Endpoint dan ESP memerlukan layanan Google berikut untuk diaktifkan:
Nama Judul
servicemanagement.googleapis.com Service Management API
servicecontrol.googleapis.com Service Control API

Dalam sebagian besar kasus, perintah gcloud endpoints services deploy mengaktifkan layanan yang diperlukan ini. Namun, perintah gcloud berhasil diselesaikan, tetapi tidak mengaktifkan layanan yang diperlukan dalam situasi berikut:

  • Jika Anda menggunakan aplikasi pihak ketiga seperti Terraform, dan Anda tidak menyertakan layanan ini.

  • Anda men-deploy konfigurasi Endpoints ke project Google Cloud yang ada, tempat layanan ini dinonaktifkan secara eksplisit.

Gunakan perintah berikut untuk mengonfirmasi bahwa layanan yang diperlukan telah diaktifkan:

gcloud services list

Jika Anda tidak melihat layanan yang diperlukan tercantum, aktifkan layanan tersebut:

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

Aktifkan juga layanan Endpoints Anda:

gcloud services enable ENDPOINTS_SERVICE_NAME

Untuk menentukan ENDPOINTS_SERVICE_NAME, Anda dapat:

  • Setelah men-deploy konfigurasi Endpoints, buka halaman Endpoints di Konsol Cloud. Daftar kemungkinan ENDPOINTS_SERVICE_NAME ditampilkan di kolom Nama layanan.

  • Untuk OpenAPI, ENDPOINTS_SERVICE_NAME adalah yang Anda tentukan di kolom host pada spesifikasi OpenAPI. Untuk gRPC, ENDPOINTS_SERVICE_NAME adalah yang Anda tentukan di kolom name pada konfigurasi Endpoint gRPC.

Untuk informasi selengkapnya tentang perintah gcloud, lihat layanan gcloud.

Men-deploy backend API

Sejauh ini, Anda telah men-deploy dokumen OpenAPI ke Pengelolaan Layanan, tetapi belum men-deploy kode yang menayangkan backend API. Bagian ini akan memandu Anda menyiapkan Docker di instance VM dan menjalankan kode backend API serta ESPv2 dalam penampung Docker.

Memeriksa izin yang diperlukan

  • Di konsol Google Cloud, buka halaman instance Compute Engine.

    Buka halaman Compute Engine

  • Pilih instance Anda dari daftar.
  • Anda dapat melihat akun layanan terkait dan izin yang dimilikinya.

  • Berikan izin yang diperlukan ke akun layanan:

    gcloud projects add-iam-policy-binding PROJECT_NAME \
  --member "serviceAccount:SERVICE_ACCOUNT" \
  --role roles/servicemanagement.serviceController

    Untuk mengetahui informasi selengkapnya, lihat Apa yang dimaksud dengan peran dan izin?

Menginstal Docker di instance VM

Untuk menginstal Docker di instance VM:

  1. Tetapkan zona untuk project Anda dengan menjalankan perintah: 
    gcloud config set compute/zone YOUR_INSTANCE_ZONE

    Ganti YOUR_INSTANCE_ZONE dengan zona tempat instance Anda berjalan.

  2. Hubungkan ke instance Anda menggunakan perintah berikut: 
    gcloud compute ssh INSTANCE_NAME

    Ganti INSTANCE_NAME dengan nama instance VM Anda.

  3. Lihat dokumentasi Docker untuk menyiapkan repositori Docker. Pastikan untuk mengikuti langkah-langkah yang sesuai dengan versi dan arsitektur instance VM Anda:
    • Jessie atau yang lebih baru
    • x86_64 / amd64

Menjalankan API dan ESPv2 di container Docker

ESPv2 adalah proxy berbasis Envoy yang berada di depan kode backend Anda. API ini memproses traffic masuk untuk memberikan autentikasi, pengelolaan kunci API, logging, dan fitur pengelolaan Endpoints API lainnya. Untuk menginstal dan menjalankan contoh API dan ESPv2 di penampung Docker:

  1. Buat jaringan penampung Anda sendiri yang disebut esp_net. 
    sudo docker network create --driver bridge esp_net
  2. Jalankan server Echo contoh yang menayangkan API contoh:
    Java
    sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-java:1.0
    Python
    sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-python:1.0
    Buka
    sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-go:1.0
    PHP
    sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-php:1.0
    Ruby
    sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-ruby:1.0
    NodeJS
    sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-node:1.0

  3. Jalankan container Docker ESPv2 publik yang telah dipaketkan sebelumnya. Di opsi startup ESPv2, ganti SERVICE_NAME dengan nama layanan Anda. Ini adalah nama yang sama dengan yang Anda konfigurasikan di kolom host dokumen OpenAPI.

    sudo docker run \
    --detach \
    --name=esp \
    --publish=80:9000 \
    --net=esp_net \
    gcr.io/endpoints-release/endpoints-runtime:2 \
    --service=SERVICE_NAME \
    --rollout_strategy=managed \
    --listener_port=9000 \
    --backend=http://echo:8080

    Opsi --rollout_strategy=managed mengonfigurasi ESPv2 untuk menggunakan konfigurasi layanan terbaru yang di-deploy. Saat Anda menentukan opsi ini, dalam satu menit setelah Anda men-deploy konfigurasi layanan baru, ESPv2 akan mendeteksi perubahan dan otomatis mulai menggunakannya. Sebaiknya tentukan opsi ini, bukan memberikan ID konfigurasi tertentu untuk digunakan ESPv2. Untuk informasi tentang opsi ESPv2 lainnya yang digunakan di atas, lihat Opsi startup ESPv2.

Jika Anda menerima pesan error, lihat Memecahkan Masalah Endpoint di Compute Engine. Lihat Men-deploy Backend API untuk informasi tambahan.

Mengirim permintaan menggunakan alamat IP

Setelah API contoh dan ESPv2 berjalan di instance Compute Engine, Anda dapat mengirim permintaan ke API dari komputer lokal.

Membuat kunci API dan menetapkan variabel lingkungan

Kode contoh memerlukan kunci API. Untuk menyederhanakan permintaan, Anda menetapkan variabel lingkungan untuk kunci API.

  1. Di project Google Cloud yang sama dengan yang Anda gunakan untuk API, buat kunci API di halaman kredensial API. Jika Anda ingin membuat kunci API di project Google Cloud yang berbeda, lihat Mengaktifkan API di project Google Cloud.

    Buka halaman Kredensial

  2. Klik Create credentials, lalu pilih API key.
  3. Salin kunci ke papan klip.
  4. Klik Close.
  5. Di komputer lokal, tempelkan kunci API untuk menetapkannya ke variabel lingkungan:
    • Di Linux atau macOS: export ENDPOINTS_KEY=AIza...
    • Di Windows PowerShell: $Env:ENDPOINTS_KEY="AIza..."

Kirim permintaan

Linux atau Mac OS

Gunakan curl untuk mengirim permintaan HTTP menggunakan variabel lingkungan ENDPOINTS_KEY yang Anda tetapkan sebelumnya. Ganti IP_ADDRESS dengan alamat IP eksternal instance Anda.

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

Dalam curl sebelumnya:

  • Opsi --data menentukan data yang akan diposting ke API.
  • Opsi --header menentukan bahwa data dalam format JSON.

PowerShell

Gunakan Invoke-WebRequest untuk mengirim permintaan HTTP menggunakan variabel lingkungan ENDPOINTS_KEY yang Anda tetapkan sebelumnya. Ganti IP_ADDRESS dengan alamat IP eksternal instance Anda.

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

Pada contoh sebelumnya, dua baris pertama diakhiri dengan tanda petik terbalik. Saat menempelkan contoh ke PowerShell, pastikan tidak ada spasi setelah tanda petik terbalik. Untuk informasi tentang opsi yang digunakan dalam contoh permintaan, lihat Invoke-WebRequest dalam dokumentasi Microsoft.

Aplikasi pihak ketiga

Anda dapat menggunakan aplikasi pihak ketiga seperti ekstensi browser Chrome Postman untuk mengirim permintaan:

  • Pilih POST sebagai kata kerja HTTP.
  • Untuk header, pilih kunci content-type dan nilai application/json.
  • Untuk isi, masukkan kode berikut:
    {"message":"hello world"}
  • Di URL, gunakan kunci API yang sebenarnya, bukan variabel lingkungan. Misalnya:
    http://192.0.2.0:80/echo?key=AIza...

API akan merespons pesan yang Anda kirim, dan merespons dengan hal berikut:

{
  "message": "hello world"
}

Jika Anda tidak mendapatkan respons yang berhasil, lihat Memecahkan masalah error respons.

Anda baru saja men-deploy dan menguji API di Endpoint.

Mengonfigurasi DNS untuk Endpoint

Karena nama layanan Endpoints untuk API berada di domain .endpoints.YOUR_PROJECT_ID.cloud.goog, Anda dapat menggunakannya sebagai nama domain yang sepenuhnya memenuhi syarat (FQDN) dengan membuat perubahan konfigurasi kecil dalam file openapi.yaml. Dengan cara ini, Anda dapat mengirim permintaan ke API contoh menggunakan echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog, bukan alamat IP.

Untuk mengonfigurasi DNS Endpoint:

  1. Buka file konfigurasi OpenAPI, openapi.yaml, dan tambahkan properti x-google-endpoints di tingkat teratas file (tidak diindentasi atau bertingkat) seperti yang ditunjukkan dalam cuplikan berikut: 
    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. Di properti name, ganti YOUR_PROJECT_ID dengan project ID Anda.
  3. Di properti target, ganti IP_ADDRESS dengan alamat IP yang Anda gunakan saat mengirim permintaan ke API contoh.
  4. Deploy file konfigurasi OpenAPI yang telah diperbarui ke Pengelolaan Layanan: 
    gcloud endpoints services deploy openapi.yaml

Misalnya, asumsikan file openapi.yaml telah mengonfigurasi hal berikut: 

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"

Saat Anda men-deploy file openapi.yaml menggunakan perintah gcloud sebelumnya, Pengelolaan Layanan akan membuat data A DNS, echo-api.endpoints.my-project-id.cloud.goog, yang me-resolve ke alamat IP target, 192.0.2.1. Mungkin perlu waktu beberapa menit agar konfigurasi DNS baru diterapkan.

Mengonfigurasi SSL

Untuk mengetahui detail selengkapnya tentang cara mengonfigurasi DNS dan SSL, lihat Mengaktifkan SSL untuk Endpoint.

Mengirim permintaan menggunakan FQDN

Setelah Anda mengonfigurasi data DNS untuk API contoh, kirim permintaan ke API tersebut menggunakan FQDN (ganti YOUR_PROJECT_ID dengan project ID Anda) dan variabel lingkungan ENDPOINTS_KEY yang ditetapkan sebelumnya:
  • Di Linux atau 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}"
  • Di 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

Melacak aktivitas API

Untuk melacak aktivitas API:

  1. Lihat grafik aktivitas untuk API Anda di halaman Endpoints > Services.

    Buka halaman Endpoints Services


    Mungkin perlu waktu beberapa saat agar permintaan ditampilkan dalam grafik.
  2. Lihat log permintaan untuk API Anda di halaman Logs Explorer.

    Buka halaman Logs Explorer

Membuat portal developer untuk API

Anda dapat menggunakan Cloud Endpoints Portal untuk membuat portal developer, situs yang dapat Anda gunakan untuk berinteraksi dengan API contoh. Untuk mempelajari lebih lanjut, lihat ringkasan Cloud Endpoints Portal.

Pembersihan

Agar tidak perlu membayar biaya pada akun Google Cloud Anda untuk resource yang digunakan dalam tutorial ini, hapus project yang berisi resource tersebut, atau simpan project dan hapus setiap resource.

  1. Hapus API: 
    gcloud endpoints services delete SERVICE_NAME

    Ganti SERVICE_NAME dengan nama layanan Anda.

  2. In the Google Cloud console, go to the VM instances page.

    Go to VM instances

  3. Select the checkbox for the instance that you want to delete.
  4. To delete the instance, click More actions, click Delete, and then follow the instructions.

Langkah selanjutnya