Halaman ini diterjemahkan oleh Cloud Translation API.

Mengonfigurasi host virtual

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Pelanggan Cloud dengan akun berbayar dan semua pelanggan Edge untuk Private Cloud dapat membuat host virtual dalam organisasi. Pengguna yang membuat host virtual harus memiliki peran administrator organisasi, atau dalam peran khusus dengan izin untuk mengubah host virtual. Pengguna dalam peran lain tidak memiliki otorisasi untuk membuat host virtual.

Tonton video pengantar {i>host<i} virtual.

Membuat host virtual

Gunakan prosedur dasar berikut untuk membuat host virtual. Prosedur sebenarnya yang Anda gunakan didasarkan pada apakah Anda adalah pelanggan Cloud atau Private Cloud, dan apakah Anda mengaktifkan TLS:

Buat entri DNS dan data CNAME untuk domain yang ditampilkan kepada publik.
Catatan: Pelanggan Private Cloud dapat membuat host virtual dari alamat IP, tanpa entri DNS dan data CNAME. Lihat Mengonfigurasi host virtual untuk Private Cloud untuk mengetahui informasi selengkapnya.
Jika mengaktifkan TLS pada host virtual:

Buat dan konfigurasi keystore menggunakan prosedur yang dijelaskan di sini: Keystore dan Truststore.
Catatan: Jika Anda memiliki akun Edge untuk Cloud berbayar dan belum memiliki sertifikat dan kunci TLS, Anda dapat membuat host virtual yang menggunakan kunci dan sertifikat uji coba gratis Apigee. Lihat Mengonfigurasi host virtual untuk Cloud.
Upload sertifikat dan kunci Anda ke keystore. Pastikan nama domain yang ditentukan oleh sertifikat Anda cocok dengan alias host yang ingin Anda gunakan untuk host virtual.
Buat referensi ke keystore dengan menggunakan UI atau API Edge. Referensi tersebut menetapkan nama keystore dan jenis referensi sebagai KeyStore. Baca artikel Menggunakan referensi untuk mengetahui informasi selengkapnya tentang cara membuat dan mengubah referensi.
Jika Anda melakukan TLS dua arah, buat truststore, upload sertifikat, dan buat referensi ke truststore. Buat truststore menggunakan prosedur yang dijelaskan di sini: Keystore dan Truststore.

Buat host virtual dengan menggunakan Create a Virtual Host API. Jika mengaktifkan TLS, pastikan untuk menentukan referensi keystore, referensi truststore, dan alias kunci yang benar.
Jika Anda sudah memiliki proxy API, tambahkan host virtual ke ProxyEndpoint. Host virtual ditambahkan secara otomatis ke semua proxy API baru. Lihat Mengonfigurasi proxy API untuk menggunakan host virtual.

Perhatian: Semua host virtual ditambahkan secara otomatis ke semua proxy API baru. Oleh karena itu, jika Anda membuat proxy API baru yang seharusnya tidak dapat diakses melalui host virtual tertentu, Anda harus mengedit proxy API untuk menghapus host virtual tersebut dari ProxyEndpoint-nya.

Setelah mengupdate proxy API untuk menggunakan host virtual, serta membuat entri DNS dan data CNAME untuk alias host, Anda dapat mengakses proxy API seperti yang ditunjukkan di bawah ini:

https://api.myCompany.com/v1/project-base-path/resource-path

Contoh:

https://api.myCompany.com/v1/weather/forecastrss?w=12797282

Membuat host virtual menggunakan API atau UI

Anda dapat membuat host virtual dengan menggunakan Edge API atau UI Edge.

Sebagian besar contoh di bawah ini menggunakan Edge API. Untuk mengakses UI guna membuat, memodifikasi, dan menghapus host virtual di UI Edge:

Login ke apigee.com/edge
Edge untuk pelanggan Private Cloud menggunakan http://ms-ip:9000 (lokal), dengan ms-ip adalah alamat IP atau nama DNS node Server Pengelolaan.
Pilih Admin >Host Virtual di menu navigasi sebelah kiri.
Pilih lingkungan, seperti prod atau test.
Host virtual yang ditentukan untuk lingkungan akan ditampilkan.
Pilih + Virtual Host untuk membuat host virtual atau pilih nama host virtual yang ada untuk mengeditnya.

Membuat host virtual untuk HTTP

Edge untuk pelanggan Private Cloud dapat membuat host virtual menggunakan HTTP.

Untuk membuat host virtual yang tidak mendukung TLS, buat objek XML yang menentukan host virtual. Misalnya, objek XML berikut menentukan host virtual yang menggunakan protokol HTTP:

<VirtualHost name="myVHost">
   <HostAliases>
     <HostAlias>api.myCompany.com</HostAlias>
   </HostAliases>
   <Interfaces/>
   <Port>80</Port>
</VirtualHost>

Dalam definisi ini Anda:

Tentukan name sebagai myVHost. Gunakan nama tersebut untuk mereferensikan host virtual dalam proxy API atau dalam panggilan API.
Tentukan alias host sebagai api.myCompany.com. Ini adalah domain yang ditampilkan kepada publik yang digunakan untuk mengakses API Anda seperti yang ditetapkan oleh definisi DNS dan data CNAME.
Tentukan nomor port sebagai 80. Jika dihilangkan, secara default port akan ditetapkan ke 443.
Ada properti tambahan yang dapat Anda tetapkan di host virtual. Untuk referensi semua properti, lihat Referensi properti host virtual.

Jika Anda sudah memiliki proxy API, tambahkan host virtual ke elemen <HTTPConnection> di Proxy Endpoint. Host virtual ditambahkan secara otomatis ke semua proxy API baru. Lihat Mengonfigurasi proxy API untuk menggunakan host virtual. Jika Anda membuat proxy API baru yang seharusnya tidak dapat diakses melalui host virtual tertentu, Anda harus mengedit proxy API untuk menghapus host virtual tersebut dari ProxyEndpoint-nya.

Kemudian Anda dapat mengakses proxy API melalui host virtual ini dengan membuat permintaan ke:

http://api.myCompany.com/proxy-base-path/resource-path
https://api.myCompany.com/proxy-base-path/resource-path

Buat host virtual dengan menggunakan Create a Virtual Host API:

curl -X POST -H "Content-Type:application/xml" \
  http://ms-IP:8080/v1/o/org_name/environments/env_name/virtualhosts \
  -d '<VirtualHost name="myVHost">
        <HostAliases>
            <HostAlias>api.myCompany.com</HostAlias>
        </HostAliases>
        <Interfaces/>
        <Port>80</Port>
    </VirtualHost>' \
  -u sysAdminEmail:password

Catatan: Di Edge untuk Private Cloud, Anda melakukan panggilan API ke nama domain ms-ip:8080 dengan ms-ip sebagai IP dari Edge Management Server. Edge untuk pelanggan Cloud membuat permintaan ke domain api.enterprise.apigee.com

Membuat host virtual untuk TLS satu arah

Objek XML berikut menentukan host virtual untuk TLS satu arah:

<VirtualHost name="myTLSVHost">
    <HostAliases>
        <HostAlias>api.myCompany.com</HostAlias>
    </HostAliases>
    <Port>443</Port>
    <SSLInfo>
        <Enabled>true</Enabled>
        <ClientAuthEnabled>false</ClientAuthEnabled>
        <KeyStore>ref://myTestKeystoreRef</KeyStore>
        <KeyAlias>myKeyAlias</KeyAlias>
    </SSLInfo>
</VirtualHost>

Dalam definisi ini, Anda mengaktifkan TLS dengan menyetel elemen <Enable> ke true, dan menggunakan elemen <KeyStore> dan <KeyAliase> untuk menentukan keystore dan alias kunci yang digunakan oleh koneksi TLS.

Catatan: Karena Edge awalnya mendukung SSL, tag yang Anda gunakan untuk mengonfigurasi TLS diberi nama <SSLInfo>.

Lihat TLS/SSL untuk informasi selengkapnya tentang cara menggunakan TLS.

Menentukan cara menentukan nama keystore dan truststore di host virtual

Saat mengonfigurasi host virtual untuk mendukung TLS, tentukan keystore menggunakan referensi. Referensi adalah variabel yang berisi nama keystore atau truststore, bukan menentukan nama keystore atau truststore secara langsung, seperti ditunjukkan di bawah ini:

    <SSLInfo>
        <Enabled>true</Enabled>
        <ClientAuthEnabled>false</ClientAuthEnabled>
        <KeyStore>ref://myTestKeystoreRef</KeyStore>
        <KeyAlias>myKeyAlias</KeyAlias>
    </SSLInfo>

Keuntungan menggunakan referensi adalah Anda dapat mengubah nilai referensi untuk mengubah keystore yang digunakan oleh host virtual, biasanya karena masa berlaku sertifikat dalam keystore saat ini akan berakhir dalam waktu dekat. Mengubah nilai referensi tidak mengharuskan Anda memulai ulang Router Edge. Lihat Menggunakan referensi untuk mengetahui informasi selengkapnya tentang cara membuat dan mengubah referensi.

Anda hanya dapat menggunakan referensi untuk keystore dan truststore; Anda tidak dapat menggunakan referensi ke alias. Saat Anda mengubah referensi ke keystore, pastikan bahwa nama alias sertifikat sama dengan yang ada di keystore lama.

Pembatasan dalam penggunaan referensi untuk keystore dan truststore

Anda harus mempertimbangkan batasan berikut saat menggunakan referensi ke keystore dan truststore:

Anda hanya dapat menggunakan referensi keystore dan truststore di host virtual jika Anda mendukung SNI dan menghentikan SSL di Router Apigee.
Jika Anda memiliki load balancer di depan Router Apigee, dan menghentikan TLS pada load balancer, Anda tidak dapat menggunakan referensi keystore dan truststore di host virtual.

Membuat {i>host<i} virtual untuk TLS dua arah

Untuk mengaktifkan TLS dua arah, tetapkan elemen <ClientAuthEnabled> ke true, dan tentukan truststore menggunakan referensi dengan elemen <TrustStore>. Truststore memegang penerbit sertifikat klien dan rantai CA sertifikat, yang diperlukan. Klien juga harus dikonfigurasi dengan benar untuk TLS dua arah.

Untuk membuat host virtual bagi TLS dua arah, buat objek XML yang menentukan host virtual:

<VirtualHost name="myTLSVHost">
    <HostAliases>
        <HostAlias>api.myCompany.com</HostAlias>
    </HostAliases>
    <Port>443</Port>
    <SSLInfo>
        <Enabled>true</Enabled>
        <ClientAuthEnabled>true</ClientAuthEnabled>
        <KeyStore>ref://myTestKeystoreRef</KeyStore>
        <KeyAlias>myKeyAlias</KeyAlias>
        <TrustStore>ref://myTestTruststoreRef</TrustStore>
    </SSLInfo>
</VirtualHost>

Dalam definisi ini Anda:

Aktifkan TLS dua arah dengan menetapkan <ClientAuthEnabled> ke benar (true).
Tentukan referensi ke truststore menggunakan elemen <TrustStore>. Truststore memegang penerbit sertifikat klien dan rantai CA sertifikat, yang diperlukan.

Lihat TLS/SSL untuk informasi selengkapnya tentang cara menggunakan TLS.

Memodifikasi {i>host<i} virtual

Pelanggan Cloud dengan akun berbayar dan semua pelanggan Edge untuk Private Cloud dapat menggunakan Update a Virtual Host API untuk mengupdate host virtual. API ini memungkinkan Anda menetapkan semua properti untuk host virtual yang dijelaskan dalam Referensi properti host virtual.

Update host virtual dengan menggunakan Update a Virtual Host API. Saat menggunakan API, Anda harus menentukan definisi lengkap host virtual dalam isi permintaan, bukan hanya elemen yang ingin diubah.

Dalam contoh ini, Anda menetapkan nilai properti proxy_read_timeout:

curl -X PUT -H "Content-Type:application/xml" \
    https://api.enterprise.apigee.com/v1/o/org_name/e/env_name/virtualhosts/vhost_name \
    -d '<VirtualHost  name="myTLSVHost">
         <HostAliases>
           <HostAlias>api.myCompany.com</HostAlias>
         </HostAliases>
         <Port>443</Port>
         <SSLInfo>
           <Enabled>true</Enabled>
           <ClientAuthEnabled>false</ClientAuthEnabled>
           <KeyStore>ref://myTestKeystoreRef</KeyStore>
           <KeyAlias>myKeyAlias</KeyAlias>
         </SSLInfo>
         <Properties>
           <Property name="proxy_read_timeout">50</Property>
         </Properties>
     </VirtualHost>' \
    -u orgAdminEmail:password

Menghapus host virtual

Agar dapat menghapus host virtual dari lingkungan, Anda harus memperbarui proxy API apa pun yang mereferensikan host virtual untuk menghapus referensi. Lihat Mengonfigurasi proxy API untuk menggunakan host virtual.

Hapus host virtual dengan menggunakan Delete a Virtual Host API:

curl -X DELETE \
  https://api.enterprise.apigee.com/v1/o/org_name/e/env_name/virtualhosts/vhost_name \
  -u orgAdminEmail:password

Melihat informasi tentang host virtual

Melihat informasi tentang host virtual yang ditentukan dalam lingkungan, seperti yang dijelaskan di bawah ini.

Edge

Untuk melihat informasi tentang host virtual menggunakan Edge UI:

Login ke apigee.com/edge.
Edge untuk pelanggan Private Cloud menggunakan http://ms-ip:9000 (lokal), dengan ms-ip adalah alamat IP atau nama DNS node Server Pengelolaan.
Pilih Admin > Virtual Hosts di menu navigasi sebelah kiri.
Pilih lingkungan, seperti prod atau test.
Host virtual yang ditentukan untuk lingkungan akan muncul. Jika host virtual dikonfigurasi untuk menggunakan keystore atau truststore, klik Show untuk melihat informasi selengkapnya.

Jika host virtual dikonfigurasi untuk menggunakan TLS/SSL, ikon gembok akan muncul di sebelah nama host virtual. Artinya, sertifikat, kunci, dan rantai sertifikat TLS/SSL telah diupload ke Edge dan dikaitkan dengan host virtual. Untuk melihat informasi tentang sertifikat yang tersedia:

Pilih Admin > Lingkungan > TLS Keystore di menu navigasi sebelah kiri.
Pilih Lingkungan (biasanya prod atau test).
Luaskan keystore untuk melihat sertifikat.

Edge Klasik (Private Cloud)

Untuk melihat informasi tentang host virtual menggunakan UI Klasik Edge:

Login ke http://ms-ip:9000, dengan ms-ip yang merupakan alamat IP atau nama DNS node Server Pengelolaan.
Pilih Admin > Virtual Hosts di menu navigasi sebelah kiri.
Pilih lingkungan, seperti prod atau test.
Klik tab Virtual Hosts.
Host virtual yang ditentukan untuk lingkungan akan muncul. Jika host virtual dikonfigurasi untuk menggunakan keystore atau truststore, klik Show untuk melihat informasi selengkapnya.

Pilih Admin > Sertifikat TLS di menu navigasi atas.
Pilih Lingkungan (biasanya prod atau test).
Luaskan keystore untuk melihat sertifikat.

Menampilkan host virtual dengan Edge API

Anda juga dapat menggunakan Edge API untuk melihat informasi tentang host virtual. Misalnya, API List Virtual Hosts menampilkan daftar semua host virtual:

curl -X GET -H "accept:application/xml" \
    https://api.enterprise.apigee.com/v1/o/org_name/environments/env_name/virtualhosts \
    -u orgAdminEmail:pWord

Dengan orgAdminEmail:pWord adalah nama pengguna dan sandi admin org, dan org_name/env_name menentukan organisasi dan lingkungan yang berisi host virtual. Contoh respons:

[
 "default",
 "secure"
]

Untuk melihat informasi tentang host virtual tertentu, gunakan Get Virtual Host API:

curl -X GET -H "accept:application/xml" \
    https://api.enterprise.apigee.com/v1/o/org_name/environments/env_name/virtualhosts/vhost_name \
    -u orgAdminEmail:pWord

Dengan vhost_name adalah nama host virtual. Misalnya, Anda dapat menetapkan vhost_name sebagai "secure" untuk melihat konfigurasi host virtual aman default yang dibuat oleh Apigee:

<VirtualHost name="secure">
    <HostAliases>
        <HostAlias>api.myCompany.com</HostAlias>
    </HostAliases>
    <Port>443</Port>
    <Properties/>
    <Interfaces/>
    <RetryOptions/>
    <SSLInfo>
        <ClientAuthEnabled>false</ClientAuthEnabled>
        <Enabled>true</Enabled>
        <KeyAlias>freetrial</KeyAlias>
        <KeyStore>ref://freetrial</KeyStore>
        <IgnoreValidationErrors>false</IgnoreValidationErrors>
    </SSLInfo>
</VirtualHost>

Catatan: Di Edge untuk Private Cloud, ganti nama domain api.enterprise.apigee.com dengan ms-ip:8080 dengan ms-ip adalah IP dari Edge Management Server.

Mengonfigurasi proxy API untuk menggunakan host virtual

Saat Anda membuat proxy API baru, Edge akan otomatis mengonfigurasinya untuk menggunakan semua host virtual yang tersedia di organisasi. Permintaan ke proxy API melalui host virtual menggunakan bentuk:

https://host-alias/proxy-base-path/resource-path

Dengan keterangan:

host-alias biasanya adalah nama DNS dari host virtual.
proxy-base-path ditentukan saat Anda membuat proxy API dan bersifat unik untuk setiap proxy API.
resource-path jalur ke resource yang dapat diakses melalui proxy API.

Mengontrol host virtual yang digunakan oleh proxy API

Dalam konfigurasi XML proxy API, Anda menggunakan tag virtualhost untuk menentukan name host virtual yang terkait dengan proxy API:

<HTTPProxyConnection>
  <BasePath>/v1/my/proxy/basepath</BasePath>
  <VirtualHost>secure</VirtualHost>
  <VirtualHost>default</VirtualHost>
</HTTPProxyConnection>

Misalnya, <VirtualHost>secure</VirtualHost> artinya klien dapat memanggil proxy API menggunakan alias host dari host virtual "aman".

Anda biasanya memodifikasi host virtual yang terkait dengan proxy API bila:

Anda membuat host virtual baru dan memiliki proxy API yang sudah ada. Anda harus mengedit proxy API yang ada untuk menambahkan host virtual baru.
Anda membuat proxy API baru yang seharusnya tidak bisa diakses melalui host virtual tertentu. Anda harus mengedit proxy API untuk menghapus host virtual itu dari definisinya.

Untuk memodifikasi host virtual yang terkait dengan proxy API:

Akses editor proxy API, seperti yang dijelaskan di bawah.
Edge

Untuk mengakses editor proxy API menggunakan Edge UI:
1. Login ke apigee.com/edge.
  Edge untuk pelanggan Private Cloud menggunakan http://ms-ip:9000 (lokal), dengan ms-ip adalah alamat IP atau nama DNS node Server Pengelolaan.
2. Pilih Develop > API proxy di menu navigasi sebelah kiri.
3. Pilih proxy API yang ingin Anda edit dalam daftar.
Edge Klasik (Private Cloud)

Catatan: UI Classic Edge hanya tersedia di Edge untuk Private Cloud.

Untuk mengakses editor proxy API menggunakan UI Edge Klasik:
1. Login ke http://ms-ip:9000, dengan ms-ip yang merupakan alamat IP atau nama DNS node Server Pengelolaan.
2. Pilih APIs > API proxy di menu navigasi atas.
3. Pilih proxy API yang ingin Anda edit dalam daftar.
Klik tab Mengembangkan.
Di bagian Endpoint Proxy, pilih default.
Di area kode:
1. Hapus semua elemen <VirtualHost> untuk host virtual yang tidak didukung oleh proxy API.
2. Tambahkan elemen <VirtualHost> baru dengan nama host virtual baru. Misalnya, jika host virtual baru diberi nama MyVirtualHost, tambahkan tag berikut:
```
<HTTPProxyConnection>
  <BasePath>/v1/my/proxy/basepath</BasePath>
  <VirtualHost>default</VirtualHost>
  <VirtualHost>secure</VirtualHost>
  <VirtualHost>MyVirtualHost</VirtualHost>
</HTTPProxyConnection>
```
Simpan proxy API. Jika proxy API telah di-deploy, simpan ulang proxy tersebut dengan setelan baru.

Menyetel URL dasar yang ditampilkan oleh UI Edge untuk proxy API

UI Edge menampilkan URL proxy API berdasarkan setelan di host virtual yang sesuai dengan tempat proxy di-deploy. Tampilan ini dapat menyertakan nomor port Router host virtual.

Pada umumnya, URL yang ditampilkan di UI Edge adalah URL yang benar untuk membuat permintaan eksternal ke proxy. Namun, untuk beberapa konfigurasi, URL yang ditampilkan tidak benar. Misalnya, salah satu konfigurasi berikut dapat menyebabkan URL yang ditampilkan yang ditampilkan tidak sesuai dengan URL sebenarnya yang digunakan untuk membuat permintaan eksternal ke proxy:

Penghentian SSL terjadi pada load balancer
Pemetaan port terjadi antara load balancer dan Router Apigee
Load balancer yang dikonfigurasi dengan penulisan ulang jalur

Edge mendukung atribut pada host virtual bernama <BaseUrl> yang memungkinkan Anda mengganti URL yang ditampilkan oleh UI Edge. Berikut adalah contoh yang menunjukkan objek host virtual dengan atribut <BaseUrl>. Dalam contoh ini, nilai "http://myCo.com" muncul di UI Edge:

<VirtualHost name="myTLSVHost">
  <HostAliases>
    <HostAlias>api.myCompany.com</HostAlias>
  </HostAliases>
  <BaseUrl>http://myCo.com</BaseUrl>
  <Port>443</Port>
  <SSLInfo>
    <Enabled>true</Enabled>
    <ClientAuthEnabled>false</ClientAuthEnabled>
    <KeyStore>ref://myTestKeystoreRef</KeyStore>
    <KeyAlias>myKeyAlias</KeyAlias>
  </SSLInfo>
</VirtualHost>

Perhatikan bahwa nilai <BaseUrl> harus menyertakan protokol (yaitu, "http://" atau "https://").

Jika <BaseUrl> tidak ditetapkan, URL default yang dirender oleh UI Edge akan muncul sebagai: "api.myCompany.com", sedangkan alias host sebenarnya adalah "http://myCo.com".