Apigee Edge belgelerini görüntülüyorsunuz.
.
Git:
Apigee X belgeleri. bilgi
Ücretli hesabı olan bir Cloud müşterisi ve Private Cloud müşterileri için tüm Edge sanal ana makine oluşturabilir. Kullanıcı sanal ana makineyi oluşturma yetkisi kuruluş yöneticisi rolünde veya değiştirme iznine sahip özel bir rol oluşturmanız gerekir. Diğer rollerdeki kullanıcılar sanal ana makine oluşturma yetkisi.
Sanal ana makinelerle ilgili tanıtım videosunu izleyin.
Sanal ana makine oluşturma
Sanal ana makine oluşturmak için aşağıdaki temel prosedürü kullanın. Gerçekleştireceğiniz prosedür, Cloud veya Private Cloud müşterisi olmanıza bağlı olarak ve TLS'yi etkinleştirip etkinleştirmediğinize bağlı olarak:
- Herkese açık alanınız için bir DNS girişi ve CNAME kaydı oluşturun.
- Sanal ana makinede TLS'yi etkinleştiriyorsanız:
- Burada açıklanan prosedürü kullanarak bir anahtar deposu oluşturun ve yapılandırın: Anahtar depoları ve Truststore'lar.
- Sertifikanızı ve anahtarınızı anahtar deposuna yükleyin. sertifikası, sanal ana makine için kullanmak istediğiniz ana makine takma adıyla eşleşir.
- Edge kullanıcı arayüzü veya API'yi kullanarak anahtar deposuna referans oluşturun. Referans
anahtar deposunun adını ve referans türünü
KeyStore
olarak belirtir. Görüntüleyin Şu kaynaklara ait referanslarla çalışma: daha fazla bilgi edineceksiniz. - İki yönlü TLS gerçekleştiriyorsanız bir güven deposu oluşturun, sertifikayı yükleyin ve güven deposuna bir referans oluşturun. Açıklanan prosedürü kullanarak güven deposunu oluşturun Keystores ve Truststores sayfasına göz atın.
- Sanal ana makineyi oluşturmak için Oluştur: Virtual Host API (Sanal Ana Makine) API'si aracılığıyla bu işlemi gerçekleştiriyor. TLS etkinleştiriliyorsa doğru anahtar deposu referansını belirtmeyi unutmayın. güven deposu referansı ve anahtar takma adı.
- Mevcut API proxy'leriniz varsa sanal ana makineyi ProxyEndpoint'e ekleyin.
Sanal ana makine, tüm yeni API proxy'lerine otomatik olarak eklenir. Görüntüleyin
Sanal ana makine kullanmak için API proxy'si yapılandırma.
.
Bir API proxy'sini sanal ana makineyi kullanacak şekilde güncelledikten ve DNS girişini ve CNAME'i oluşturduktan sonra ana makine takma adı için API proxy'sine aşağıda gösterildiği gibi erişebilirsiniz:
https://api.myCompany.com/v1/project-base-path/resource-path
Örneğin:
https://api.myCompany.com/v1/weather/forecastrss?w=12797282
API veya kullanıcı arayüzünü kullanarak sanal ana makine oluşturma
Edge API veya Edge kullanıcı arayüzünü kullanarak sanal ana makine oluşturabilirsiniz.
Aşağıdaki örneklerin çoğu Edge API'yi kullanır. Oluşturma, değiştirme ve silme amacıyla kullanılan kullanıcı arayüzüne erişmek için sanal ana makineler:
- apigee.com/edge adresinde oturum açın
Private Cloud müşterileri için Edge
http://ms-ip:9000
(şirket içi) kullanır; burada ms-ip değeri: Yönetim Sunucusu düğümünün IP adresi veya DNS adı. - Sol gezinme çubuğunda Admin >Virtual Hosts (Yönetici > Sanal Ana Makineler) seçeneğini belirleyin.
- Üretim veya test gibi bir ortam seçin.
. Sanal ortam için tanımlanan ana makineler görüntülenir. - Sanal ana makine oluşturmak için + Sanal Ana Makine'yi seçin veya mevcut sanal ana makineyi kullanın.
HTTP için sanal ana makine oluşturma
Private Cloud müşterileri için Edge, HTTP kullanarak sanal ana makine oluşturabilir.
TLS'yi desteklemeyen bir sanal ana makine oluşturmak için TLS'yi destekleyen sanal ana makine. Örneğin, aşağıdaki XML nesnesi HTTP kullanan bir sanal ana makine tanımlar protokol:
<VirtualHost name="myVHost"> <HostAliases> <HostAlias>api.myCompany.com</HostAlias> </HostAliases> <Interfaces/> <Port>80</Port> </VirtualHost>
Bu tanımda:
- name'i (ad) myVHost olarak belirtin. Referans için bu adı kullanın API proxy'sindeki veya API çağrısındaki sanal ana makineye göre değişir.
- Ana makine takma adını api.Sirketim.com olarak belirtin. Bu, API'lerinize erişmek için kullanılan ve DNS tanımı ve CNAME ile tanımlanan herkese açık alan kullanabilirsiniz.
- Bağlantı noktası numarasını 80 olarak belirtin. Atlanırsa varsayılan olarak bağlantı noktası 443 olarak ayarlanmalıdır.
Sanal ana makinede ayarlayabileceğiniz ek özellikler vardır. Tüm tesislerle ilgili referans için bkz. Sanal ana makine mülk referansı.
Mevcut API proxy'leriniz varsa sanal ana makineyi <HTTPConnection>
öğesine ekleyin
proxy'sini kullanabilirsiniz. Sanal ana makine, tüm yeni API proxy'lerine otomatik olarak eklenir.
Sanal ana makine kullanmak için API proxy'si yapılandırma başlıklı makaleye bakın.
Belirli bir sanal ana makine üzerinden erişilmemesi gereken yeni bir API proxy'si oluşturursanız
API proxy'sini düzenleyerek bu sanal ana makineyi ProxyEndpoint'ten kaldırmanız gerekir.
Ardından, şunun için istekte bulunarak bu sanal ana makine üzerinden bir API proxy'sine erişebilirsiniz:
http://api.myCompany.com/proxy-base-path/resource-path https://api.myCompany.com/proxy-base-path/resource-path
Sanal ana makineyi oluşturmak için Oluştur: Sanal Ana Makine API'si:
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
Tek yönlü TLS için sanal ana makine oluşturma
Aşağıdaki XML nesnesi, tek yönlü TLS için bir sanal ana makine tanımlar:
<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>
Bu tanımda, <Enable>
öğesini ayarlayarak TLS'yi etkinleştirirsiniz
ve <KeyStore>
ile <KeyAliase>
öğelerini kullanın
kullanın.
Daha fazla bilgi için TLS/SSL başlıklı makaleyi inceleyin. TLS kullanma hakkında bilgi.
Sanal ana makinede anahtar deposu ve güven deposu adının nasıl belirtileceğine karar verme
TLS'yi destekleyecek şekilde bir sanal ana makine yapılandırırken referans: Referans, anahtar deposunun adını veya güven deposunu kullanın:
<SSLInfo> <Enabled>true</Enabled> <ClientAuthEnabled>false</ClientAuthEnabled> <KeyStore>ref://myTestKeystoreRef</KeyStore> <KeyAlias>myKeyAlias</KeyAlias> </SSLInfo>
Referans kullanmanın avantajı, referansın değerini değiştirerek sanal ana makine tarafından kullanılan anahtar deposudur. Bunun nedeni, genellikle mevcut anahtar deposundaki sertifikanın yakında sona erecektir. Referansın değerini değiştirmek, yeniden başlatmanızı gerektirmez uç yönlendirici. Ayrıntılar için bkz. Referanslarla çalışma daha fazla bilgi edineceksiniz.
Yalnızca anahtar deposuna ve güven deposuna yönelik bir referans kullanabilirsiniz; takma ad'dır. Referansı bir anahtar deposu olarak değiştirdiğinizde, sertifikanın takma ad adının eski anahtar deposunda olduğu gibidir.
Anahtar depolarına ve güven deposuna referansların kullanımıyla ilgili kısıtlamalar
Anahtar depolarına referanslar kullanırken aşağıdaki kısıtlamayı dikkate almanız gerekir. güven depoları:
- Sanal ana makinelerde anahtar deposu ve güven deposu referanslarını yalnızca SNI ve Apigee Yönlendiricilerinde SSL'yi sonlandırmanız gerekir.
- Apigee Yönlendiricilerinin önünde bir yük dengeleyiciniz varsa ve bu yönlendiricide TLS'yi sonlandırırsanız sanal ana makinelerde anahtar deposu ve güven deposu referanslarını kullanamazsınız.
İki yönlü TLS için sanal ana makine oluşturma
İki yönlü TLS'yi etkinleştirmek için <ClientAuthEnabled>
öğesini
true
ve bir güven deposu belirtin
<TrustStore>
öğesi içeren bir referans kullanarak. Truststore
istemcinin sertifikasını veren kuruluşa ve sertifikanın gerekli olan CA zincirine sahiptir. Müşteri
iki yönlü TLS için doğru şekilde yapılandırılmalıdır.
İki yönlü TLS için bir sanal ana makine oluşturmak üzere sanal makineyi tanımlayan bir XML nesnesi barındırıcı:
<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>
Bu tanımda:
<ClientAuthEnabled>
öğesini doğru değerine ayarlayarak iki yönlü TLS'yi etkinleştirin.<TrustStore>
öğesini kullanarak güven deposu referansını belirtin. Truststore istemcinin sertifikasını veren kuruluşa ve sertifikanın gerekli olan CA zincirine sahiptir.
Daha fazla bilgi için TLS/SSL başlıklı makaleyi inceleyin. TLS kullanma hakkında bilgi.
Sanal ana makineyi değiştirme
Ücretli hesabı ve tüm Edge for Private Cloud müşterileri olan Cloud müşterileri Bir sanal ana makineyi güncellemek için Virtual Host API'yi güncelleyin. Bu API, tüm reklam alanlarını özellikleri için Sanal ana makine özelliği referansı bölümünde açıklanmaktadır.
Virtual Host API'yi güncelleyin. API'yi kullanırken sanal ana makineyi değil, yalnızca değiştirmek istediğiniz öğeleri değil,
Bu örnekte, proxy_read_timeout
özelliğinin değerini ayarladınız:
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
Sanal ana makine silme
Bir ortamdan sanal ana makineyi silmeden önce sanal ana makineye başvurup referansı kaldırabilirsiniz. Görüntüleyin Bir sanal makineyi kullanmak için API proxy'sini ana makine.
Sanal ana makineyi silmek için Virtual Host API'yi silin:
curl -X DELETE \ https://api.enterprise.apigee.com/v1/o/org_name/e/env_name/virtualhosts/vhost_name \ -u orgAdminEmail:password
Sanal ana makineyle ilgili bilgileri görüntüleme
Aşağıda açıklanan şekilde, bir ortamda tanımlanan sanal ana makineler hakkındaki bilgileri görüntüleyin.
Edge
Edge kullanıcı arayüzünü kullanarak bir sanal ana makineyle ilgili bilgileri görüntülemek için:
- apigee.com/edge adresinde oturum açın.
Private Cloud müşterileri için Edge
http://ms-ip:9000
(şirket içi) kullanır; burada ms-ip değeri: Yönetim Sunucusu düğümünün IP adresi veya DNS adı. - Yönetici > Virtual Hosts (Sanal Ana Makineler) seçeneğini tıklayın.
- Üretim veya test gibi bir ortam seçin.
Sanal ortam için tanımlanan ana makineler görünür. Sanal ana makine bir anahtar deposu veya güven deposu kullanacak şekilde yapılandırılmışsa daha fazla bilgi için Göster'i tıklayın.
Sanal ana makine TLS/SSL kullanacak şekilde yapılandırılmışsa sanal ana makine. Bu, Edge'dir ve sanal ana makineyle ilişkilendirilir. Mevcut cihazlarla ilgili bilgileri görmek için sertifikalar:
- Yönetici > Ortam > TLS Anahtar Depoları'nı tıklayın.
- Ortamı seçin (genellikle
prod
veyatest
). - Sertifikayı görüntülemek için anahtar depolarını genişletin.
Klasik Edge (Private Cloud)
Klasik Edge kullanıcı arayüzünü kullanarak bir sanal ana makine hakkındaki bilgileri görüntülemek için:
- ms-ip olan
http://ms-ip:9000
uygulamasında oturum açın Yönetim Sunucusu düğümünün IP adresi veya DNS adı. - Yönetici > Virtual Hosts (Sanal Ana Makineler) seçeneğini tıklayın.
- Üretim veya test gibi bir ortam seçin.
- Virtual Hosts (Sanal Ana Makineler) sekmesini tıklayın.
Sanal ortam için tanımlanan ana makineler görünür. Sanal ana makine bir anahtar deposu veya güven deposu kullanacak şekilde yapılandırılmışsa daha fazla bilgi için Göster'i tıklayın.
Sanal ana makine TLS/SSL kullanacak şekilde yapılandırılmışsa sanal ana makine. Bu, Edge'dir ve sanal ana makineyle ilişkilendirilir. Mevcut cihazlarla ilgili bilgileri görmek için sertifikalar:
- Yönetici > TLS Sertifikaları'nı tıklayın.
- Ortamı seçin (genellikle
prod
veyatest
). - Sertifikayı görüntülemek için anahtar depolarını genişletin.
Görüntüleme Edge API'ye sahip bir sanal ana makine
Sanal ana makineler hakkındaki bilgileri görüntülemek için Edge API'lerini de kullanabilirsiniz. Örneğin, Liste Sanal Hosts API, tüm sanal ana makinelerin listesini döndürür:
curl -X GET -H "accept:application/xml" \ https://api.enterprise.apigee.com/v1/o/org_name/environments/env_name/virtualhosts \ -u orgAdminEmail:pWord
Burada orgAdminEmail:pWord, kuruluş yöneticisinin kullanıcı adı ve şifresidir ve org_name/env_name, sanal ana makineyi barındıran kuruluş ve ortam. Örnek yanıt:
[ "default", "secure" ]
Belirli bir sanal ana makineyle ilgili bilgileri görmek için Virtual Host API'yi alın:
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
Burada vhost_name, sanal ana makineyi kullanır. Örneğin, vhost_name öğesini "güvenli" olarak belirtebilirsiniz. - Apigee tarafından oluşturulan varsayılan güvenli sanal ana makinenin yapılandırmasını inceleyin:
<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>
Sanal bir sunucu kullanmak için API proxy'si yapılandırma düzenleyen
Yeni bir API proxy'si oluşturduğunuzda Edge bunu mevcut tüm sanal düzenleyen kişilerdir. Bir sanal ana makine üzerinden API proxy'sine gönderilen istekler şu formu kullanır:
https://host-alias/proxy-base-path/resource-path
Burada:
- host-alias genellikle sanal ana makinenin DNS adıdır.
- proxy-base-path, API proxy'si oluşturduğunuzda tanımlanır ve her biri için benzersizdir API proxy'si.
- API proxy'si üzerinden erişilebilen bir kaynağın yolunu resource-path.
API proxy'si tarafından kullanılan sanal ana makineleri kontrol etme
Bir API proxy'sinin XML yapılandırmasında, virtualhost
API proxy'siyle ilişkili sanal ana makinenin adı:
<HTTPProxyConnection> <BasePath>/v1/my/proxy/basepath</BasePath> <VirtualHost>secure</VirtualHost> <VirtualHost>default</VirtualHost> </HTTPProxyConnection>
Örneğin, <VirtualHost>secure</VirtualHost>
şu anlama gelir:
bir istemci, "güvenli" adresinin ana makine takma adını kullanarak API proxy'sini çağırabilir sanal ana makine.
API proxy'si ile ilişkili sanal ana makineleri genellikle şu durumlarda değiştirirsiniz:
- Yeni bir sanal ana makine oluşturdunuz ve mevcut API proxy'leriniz var. Mevcut API'leri düzenlemeniz gerekir yeni sanal ana makine ekleyin.
- Belirli bir sanal ana makine üzerinden erişememesi gereken yeni bir API proxy'si oluşturuyorsunuz. Sanal ana makineyi tanımından kaldırmak için API proxy'sini düzenlemeniz gerekir.
API proxy'si ile ilişkili sanal ana makineleri değiştirmek için:
-
Aşağıda açıklandığı şekilde API proxy düzenleyicisine erişin.
Edge
Edge kullanıcı arayüzünü kullanarak API proxy düzenleyicisine erişmek için:
- apigee.com/edge adresinde oturum açın.
Private Cloud müşterileri için Edge
http://ms-ip:9000
(şirket içi) kullanır; burada ms-ip değeri: Yönetim Sunucusu düğümünün IP adresi veya DNS adı. - Geliştir > API proxy'leri bölümünü inceleyin.
- Listede düzenlemek istediğiniz API proxy'sini seçin.
Klasik Edge (Private Cloud)
Klasik Edge kullanıcı arayüzünü kullanarak API proxy düzenleyicisine erişmek için:
- ms-ip olan
http://ms-ip:9000
uygulamasında oturum açın Yönetim Sunucusu düğümünün IP adresi veya DNS adı. - API'ler > API proxy'leri bölümünü ziyaret edin.
- Listede düzenlemek istediğiniz API proxy'sini seçin.
- apigee.com/edge adresinde oturum açın.
- Geliştirme sekmesini tıklayın.
- Proxy Uç Noktaları altında, varsayılan'ı seçin.
- Kod alanında:
- Şu öğenin tüm
<VirtualHost>
öğelerini kaldırın: API proxy'si tarafından desteklenmeyen sanal ana makineler. - Yeni bir
<VirtualHost>
öğesi ekleyin yeni sanal ana makinenin adını yazın. Örneğin, yeni sanal ana makinenin adı MyVirtualHost adresine aşağıdaki etiketi ekleyin:
<HTTPProxyConnection> <BasePath>/v1/my/proxy/basepath</BasePath> <VirtualHost>default</VirtualHost> <VirtualHost>secure</VirtualHost> <VirtualHost>MyVirtualHost</VirtualHost> </HTTPProxyConnection>
- Şu öğenin tüm
- API proxy'sini kaydedin. API proxy'si dağıtıldıysa proxy kaydedildiğinde yeni ayarını değiştirebilirsiniz.
API proxy'si için uç kullanıcı arayüzü
Edge kullanıcı arayüzü, sanal ana makinedeki ayarlara göre bir API proxy'sinin URL'sini gösteriyor proxy'nin dağıtıldığı yere göre değişir. Bu ekran, şu yönlendirici bağlantı noktası numarasını içerebilir: sanal ana makineyi kullanır.
Çoğu durumda, Edge kullanıcı arayüzünde görüntülenen URL, harici URL'ler oluşturmak için tek bir kodla çalışır. Ancak, bazı yapılandırmalar için görünen URL doğru değildir. Örneğin, aşağıdaki yapılandırmalardan herhangi biri, görünen URL'nin proxy'ye harici isteklerde bulunmak için kullanılan gerçek URL'ye karşılık gelir:
- SSL sonlandırması, yük dengeleyicide gerçekleşir
- Bağlantı noktası eşlemesi yük dengeleyici ile Apigee Yönlendiricileri arasında gerçekleşir
- Yol yeniden yazmayla yapılandırılmış bir yük dengeleyici
Edge, sanal ana makinede <BaseUrl>
adlı bir özelliği destekler. Bu özellik,
Edge kullanıcı arayüzü tarafından gösterilen URL'yi geçersiz kılarsınız. Aşağıda, sanal ana makine nesnesini gösteren bir örnek verilmiştir
<BaseUrl>
özelliği.
Bu örnekte, "http://myCo.com" değeri Edge kullanıcı arayüzünde görünür:
<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>
<BaseUrl>
değerinin protokolü (ör. "http://" veya
"https://").
<BaseUrl>
ayarlanmazsa Edge kullanıcı arayüzü tarafından oluşturulan varsayılan URL
"api.Sirketim.com" şeklinde görünür. Gerçek ana makine takma adı ise "http://sirketim.com"dur.