Setelah API di-deploy, pengguna API harus mengaksesnya melalui nama domain, bukan alamat IP. Anda dapat:
- Konfigurasikan
.endpoints.PROJECT_ID.cloud.goog
sebagai nama domain (denganPROJECT_ID
adalah project ID Google Cloud Anda). - Atau daftarkan nama domain Anda sendiri, seperti
example.com
, yang memerlukan:- Mengonfigurasi server nama DNS (atau menggunakan Cloud DNS).
- Memperbarui alamat registry.
- Membuat dan mengelola data DNS.
Jika Anda sudah memiliki infrastruktur DNS, atau ingin mendaftarkan nama domain Anda sendiri, lihat Menayangkan API dari nama domain Anda untuk mengetahui informasi selengkapnya.
Halaman ini menjelaskan cara mengonfigurasi Cloud Endpoints API untuk menggunakan
.endpoints.PROJECT_ID.cloud.goog
sebagai nama
domain. Langkah-langkah konfigurasi di halaman ini berlaku untuk API yang menggunakan gRPC yang berjalan di Compute Engine, Google Kubernetes Engine, atau Kubernetes.
Domain .cloud.goog
dikelola oleh Google dan digunakan bersama oleh pelanggan Google Cloud. Karena project Google Cloud dijamin memiliki project ID yang unik secara global,
nama domain dalam format .endpoints.PROJECT_ID.cloud.goog
bersifat unik dan
dapat digunakan sebagai nama domain untuk API Anda. Mengonfigurasi nama domain .endpoints.PROJECT_ID.cloud.goog
bersifat opsional. Jika mau, Anda
dapat mendaftarkan nama domain Anda sendiri.
Prasyarat
Sebagai titik awal, halaman ini mengasumsikan bahwa Anda telah membuat Cloud Endpoints API dan men-deploy-nya ke Compute Engine, Google Kubernetes Engine, atau Kubernetes. Jika memerlukan API untuk pengujian, Anda dapat menggunakan salah satu tutorial yang memandu Anda mengonfigurasi dan men-deploy contoh API.
Mengonfigurasi DNS
Prosedur berikut menjelaskan cara mengonfigurasi DNS untuk
Endpoints API yang menggunakan
.endpoints.PROJECT_ID.cloud.goog
sebagai
nama layanan Endpoints. Untuk memudahkan, prosedur ini merujuk pada
file konfigurasi layanan gRPC Anda sebagai service.yaml
.
Untuk mengonfigurasi DNS:
- Buka
service.yaml
, lalu tambahkan kolomendpoints
ke file seperti yang ditunjukkan dalam cuplikan kode berikut:type: google.api.Service name: API_NAME.endpoints.PROJECT_ID.cloud.goog endpoints: - name: API_NAME.endpoints.PROJECT_ID.cloud.goog target: "IP_ADDRESS"
Biasanya, kolom
name
dan kolomendpoints.name
sama. - Ganti
API_NAME
dengan nama API Anda (misalnya,bookstore
ataumy-cool-api
). - Ganti
IP_ADDRESS
dengan alamat IPv4. Alamat IP adalah string dan harus diapit tanda kutip.Misalnya, jika men-deploy layanan Endpoints API ke instance virtual machine Compute Engine, Anda dapat menggunakan alamat IP eksternal virtual machine tersebut. Atau, jika menjalankan kode di grup instance virtual machine (atau pod GKE) di belakang load balancer, Anda dapat menggunakan alamat IP load balancer.
- Deploy file konfigurasi gRPC yang telah diperbarui ke Pengelolaan Layanan menggunakan perintah berikut:
gcloud endpoints services deploy service.yaml service.pb
Misalnya, jika hal berikut ditentukan dalam file service.yaml
:
type: google.api.Service name: my-cool-api.endpoints.my-project-id.cloud.goog endpoints: - name: my-cool-api.endpoints.my-project-id.cloud.goog target: "192.0.2.1"
Saat Anda men-deploy file service.yaml
menggunakan perintah gcloud
sebelumnya,
Pengelolaan Layanan akan membuat data A DNS,
my-cool-api.endpoints.my-project-id.cloud.goog
, yang me-resolve ke alamat IP
target, 192.0.2.1
. Anda mungkin perlu menunggu beberapa menit agar konfigurasi DNS
baru diterapkan.
Langkah selanjutnya
- Mengonfigurasi Endpoint
- Mengaktifkan SSL untuk Endpoint
- Mencadangkan alamat IP eksternal statis
- Menayangkan API dari nama domain Anda