Halaman ini menunjukkan cara menayangkan API dari domain kustom yang Anda miliki, misalnya, example.com.
Sebagai alternatif untuk menggunakan nama domain Anda sendiri, Anda dapat menggunakan nama domain
yang dikelola oleh Google. Lihat
Menggunakan domain yang dikelola oleh Google
untuk mengetahui informasi selengkapnya.
Sebelum memulai
Dapatkan nama domain dari registrar nama domain jika Anda belum memiliki nama domain untuk digunakan untuk API Anda.
Mengonfigurasi project API untuk menggunakan nama domain Anda
Ikuti petunjuk di tab yang sesuai.
Compute Engine
Cara yang direkomendasikan untuk menayangkan API dari instance Compute Engine adalah menggunakan load balancer di seluruh grup instance. Anda perlu mencadangkan alamat IP eksternal untuk nama domain dan menggunakan alamat IP eksternal tersebut untuk load balancer.
Untuk menayangkan API dari nama domain:
Cadangkan minimal satu alamat IP eksternal statis di project Anda:
Tetapkan nama yang Anda inginkan ke alamat IP yang dicadangkan
Untuk Jenis, klik Global.
Untuk Ditautkan ke, klik Tidak ada. Anda akan melampirkan alamat IP ke load balancer nanti.
Buka akun penyedia domain Anda dan edit setelan domain. Anda
harus membuat data A yang berisi nama API, misalnya,
myapi.example.com dengan alamat IP eksternal di kolom datanya
Buat grup instance yang menyertakan instance yang menjalankan API dan
Extensible Service Proxy (ESP:
Klik Define a Backend Service > Create or select a backend service.
Tetapkan nama dan deskripsi yang Anda inginkan untuk konfigurasi layanan backend ini.
Di kolom Protocol, pilih protokol yang ingin Anda
dukung melalui load balancer, HTTP atau HTTPS.
Dalam daftar Instance group, klik grup instance Anda.
Di kolom Port Numbers, masukkan 8080.
Klik Health check untuk mengonfigurasi health check:
Masukkan nama untuk konfigurasi health check.
Tetapkan port 8080.
Untuk menyetujui nilai default yang tersisa, klik Simpan.
Untuk saat ini, terima setelan default untuk konfigurasi lainnya.
Anda dapat melakukan perubahan nanti sesuai kebutuhan, seperti port tambahan.
Anda tidak perlu menetapkan apa pun di Aturan host dan jalur; Anda
dapat meneruskan semuanya ke API backend menggunakan filter
Semua yang tidak cocok default. Artinya, semua traffic ke load balancer diarahkan ke API di port 8080 (port default) seperti yang ditentukan pada langkah sebelumnya.
Klik Frontend configuration.
Di kolom Protocol, pilih protokol yang ingin Anda
dukung melalui load balancer, HTTP atau HTTPS.
Dalam daftar IP, klik alamat IP eksternal yang Anda buat
sebelumnya.
Untuk protokol HTTPS, Anda harus menggunakan SSL. Di daftar
Certificate, klik sertifikat yang Anda inginkan.
Atau, jika Anda ingin mendukung protokol lain, klik Add frontend IP and port, tentukan protokol, alamat IP eksternal yang sama, dan port yang berbeda.
Untuk membuat load balancer yang dikonfigurasi sepenuhnya, klik Create. Jika
tombol Create tidak diaktifkan, periksa komponen yang baru saja
Anda konfigurasi: tanda centang akan muncul di samping setiap
komponen konfigurasi. Tanda centang yang tidak ada berarti Anda belum menyelesaikan konfigurasi.
Setelah perubahan DNS diterapkan, permintaan akan dikirim ke API Anda menggunakan load balancer.
GKE
Untuk menayangkan API melalui domain untuk Google Kubernetes Engine (GKE), Anda perlu mengekspos ESP sebagai layanan, dengan menggunakan alamat IP eksternal yang ditampilkan untuk setelan DNS domain Anda. Perhatikan bahwa GKE
otomatis melakukan load balancing untuk Anda.
Untuk mengekspos API sebagai layanan:
Jika belum memilikinya,
Konfigurasi layanan Kubernetes
untuk backend API Anda. Buat file konfigurasi layanan,
service.yaml, dengan konten yang mirip dengan berikut:
Buka akun penyedia domain Anda dan edit setelan domain. Anda
harus membuat data A yang berisi nama API, misalnya,
myapi.example.com, dengan alamat IP eksternal di kolom datanya.
[[["Mudah dipahami","easyToUnderstand","thumb-up"],["Memecahkan masalah saya","solvedMyProblem","thumb-up"],["Lainnya","otherUp","thumb-up"]],[["Sulit dipahami","hardToUnderstand","thumb-down"],["Informasi atau kode contoh salah","incorrectInformationOrSampleCode","thumb-down"],["Informasi/contoh yang saya butuhkan tidak ada","missingTheInformationSamplesINeed","thumb-down"],["Masalah terjemahan","translationIssue","thumb-down"],["Lainnya","otherDown","thumb-down"]],["Terakhir diperbarui pada 2025-08-18 UTC."],[[["\u003cp\u003eThis page guides users on serving an API from a custom domain they own, such as \u003ccode\u003eexample.com\u003c/code\u003e, as an alternative to using a Google-managed domain.\u003c/p\u003e\n"],["\u003cp\u003eBefore beginning, users must obtain a domain name, verify ownership, name their API host, obtain an SSL certificate if needed, and deploy their API and Extensible Service Proxy (ESP).\u003c/p\u003e\n"],["\u003cp\u003eFor Compute Engine, users need to reserve a static external IP address, create an A record with their API name and the external IP, set up an instance group, and configure an HTTP(S) load balancer.\u003c/p\u003e\n"],["\u003cp\u003eFor Google Kubernetes Engine (GKE), users must configure a Kubernetes service, expose ESP as a service to get an external IP address, change this address to static, and create an A record with the API name and the static IP.\u003c/p\u003e\n"],["\u003cp\u003eAfter completing the configuration steps and DNS changes propagate, requests will be sent to the user's API through the load balancer or service.\u003c/p\u003e\n"]]],[],null,["# Serving an API from your domain name\n\n[OpenAPI](/endpoints/docs/openapi/serving-apis-from-domains \"View this page for the Cloud Endpoints OpenAPI docs\") \\| gRPC\n\n\u003cbr /\u003e\n\nThis page shows how to serve an API from a custom domain that you own, for\nexample, `example.com`.\n\nAs an alternative to using your own domain name, you can use a domain name\nmanaged by Google. See\n[Using a domain managed by Google](/endpoints/docs/grpc/configure-endpoints#using_a_domain_managed_by_google)\nfor more information.\n\nBefore you begin\n----------------\n\n- Obtain a domain name from a domain name registrar if you don't already have a domain name to use for your API.\n- [Verify domain ownership](/endpoints/docs/grpc/verify-domain-name).\n- [Name your API host name](/endpoints/docs/grpc/configure-endpoints) with your domain name.\n- If you are using SSL with your domain, obtain and upload your SSL certificate.\n- [Deploy your API and Extensible Service Proxy (ESP)](/endpoints/docs/grpc/deploy-api-backend).\n\nConfigure your API project to use your domain name\n--------------------------------------------------\n\nFollow the instructions in the appropriate tab. \n\n### Compute Engine\n\nThe recommended way to serve an API from Compute Engine instances is\nto use a load balancer across an instance group. You need to reserve an\nexternal IP address for the domain name and use that external IP address for\nthe load balancer.\n\nTo serve the API from a domain name:\n\n1. Reserve at least one static external IP address in your project: \n\n [Go to the External IP Addresses page](https://console.cloud.google.com/networking/addresses/add)\n 1. Assign any name you want to the reserved IP address\n 2. For **Type** , click **Global**.\n 3. For **Attached to** , click **None**. You attach the IP address to a load balancer later.\n2. Visit your domain provider account and edit your domain settings. You must create an *A record* that contains your API name, for example, `myapi.example.com` with the external IP address in its data field\n3. Create an instance group that includes the instances running your API and Extensible Service Proxy (ESP: \n\n [Go to the Create a New Instance group page](https://console.cloud.google.com/compute/instanceGroups/add)\n 1. Assign any name you want for the group and add a description.\n 2. From the **Zone** list, click the zone used by your API instance.\n 3. In the **Instance definition** list, click **Select existing instances**\n 4. In the **VM Instances** field, add the VM instance running the API.\n 5. Click **Create**.\n4. Create and configure an HTTP(S) load balancer: \n\n [Go to the Create a New HTTP(S) load balancer page](https://console.cloud.google.com/networking/loadbalancing/http/add)\n 1. Click **Define a Backend Service** \\\u003e **Create or select a backend service** . \n 2. Assign any name and description you want for this backend service configuration.\n 3. In the **Protocol** field, select the protocol you want to support through the load balancer, **HTTP** or **HTTPS**.\n 4. In the **Instance group** list, click your instance group.\n 5. In the **Port Numbers** field, enter `8080`.\n 6. Click **Health check** to configure health checks:\n - Enter a name for the health check configuration.\n - Assign the port `8080`.\n - To accept the remaining default values, click **Save**.\n 7. For now, accept the defaults for the rest of the configuration. You can make changes later as needed, such as additional ports.\n 8. You don't need to set anything in the **Host and path rules** ; you can forward everything to your backend API by using the default **Any unmatched** filters. This means that all traffic into the load balancer is directed to the API on the port `8080` (the default port) as defined in the preceding steps.\n 9. Click **Frontend configuration** . \n - In the **Protocol** field, select the protocol you want to support through the load balancer, **HTTP** or **HTTPS**.\n - In the **IP** list, click the external IP address you created earlier.\n - For the HTTPS protocol, you need to use SSL. In the **Certificate** list, click the certificate you want.\n - Optionally, if you want to support another protocol, click **Add frontend IP and port**, specify the protocol, the same external IP address, and a different port.\n 10. To create the fully configured load balancer, click **Create** . If the **Create** button isn't enabled, check the components you just configured: a checkmark should appear beside each of the configuration components. A missing checkmark means you haven't completed the configuration.\n 11. After your DNS changes propagate, requests are sent to your API by using the load balancer.\n | **Note:** If requests aren't making it through to your API backend, check your project's [firewall rules](https://console.cloud.google.com/networking/firewalls/list) to make sure your instances can accept traffic on the default ESP port `8080`. For more information, see [Firewalls](/compute/docs/networking#firewalls).\n\n### GKE\n\nTo serve an API over a domain for\nGoogle Kubernetes Engine (GKE), you need to\nexpose ESP as a service, by using the returned external IP\naddress for your domain's DNS settings. Note that GKE\nautomatically does load balancing for you.\n\nTo expose your API as a service:\n\n1. If you don't have one already, [Configure a Kubernetes service](https://kubernetes.io/docs/tasks/access-application-cluster/connecting-frontend-backend/) for your API backends. Create a service configuration file, `service.yaml`, with content similar to the following: \n\n ```\n apiVersion: v1\n kind: Service\n metadata:\n name: echo\n spec:\n ports:\n - port: 80\n targetPort: 8081\n protocol: TCP\n selector:\n app: echo-app\n type: LoadBalancer\n \n ```\n - Change the `selector` label to match your backend labels (`app: echo-app` in this example)\n - Make sure the `targetPort` matches the port used by ESP configured in your API backends. ESP uses port `8081` by default.\n2. Deploy the Kubernetes service: \n\n ```\n kubectl apply -f service.yaml\n \n ```\n3. View the external IP address assigned to your exposed service: \n\n ```\n kubectl get services\n \n ```\n The output displays an `EXTERNAL-IP` address similar to the following: \n\n ```\n NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE\n hello-node 10.X.XXX.202 10X.XXX.XX.123 8080/TCP 1m\n \n ```\n | **Note:** It takes awhile for the API to be exposed as a service, and the external IP isn't visible until this process is complete. So you might have to run `kubectl get services` several times before you see the IP address.\n4. Change the generated external IP from ephemeral to static. \n\n [Go to the External IP Addresses page](https://console.cloud.google.com/networking/addresses/list)\n 1. Select your external IP address from the list.\n 2. In the **Type** list, click **Static**.\n5. Visit your domain provider account and edit your domain settings. You must create an *A record* that contains your API name, for example, `myapi.example.com`, with the external IP address in its data field.\n\nWhat's next\n-----------\n\n- [Serving multiple APIs from a domain](/endpoints/docs/grpc/deploying-apis-subdomains)"]]
