Bu konu, API Gateway kullanarak bir VPC'deki arka uç hizmetine nasıl erişileceğini açıklar. Ayrıca güvenli API çağrıları için Alibaba Cloud App'ten AppCode kimlik doğrulamasının nasıl kullanılacağını gösterir.
Önkoşullar
Bir VPC'niz olmalıdır. Daha fazla bilgi için bkz. IPv4 CIDR bloğu içeren bir VPC oluşturma ve IPv6 CIDR bloğu içeren bir VPC oluşturma.
Bir ECS örneğiniz olmalıdır. Daha fazla bilgi için bkz. ECS örneği oluşturma.
VPC içinde bir Server Load Balancer (SLB) örneği ve bir ECS örneği satın alın; hizmetinizi dağıtın.
Bu örnekte API Gateway'in arka uç hizmeti, bir VPC'deki bir ECS örneğidir. ECS örneğine 80 numaralı bağlantı noktasında bir Nginx web hizmeti dağıtılmıştır.
Yordam
API Gateway ile bir VPC'deki arka uç hizmetine erişmek için aşağıdaki adımları izleyin:
VPC erişim yetkilendirmesi oluşturma
API Gateway'in VPC'nize erişmesine olanak tanımak için bir VPC erişim yetkilendirmesi oluşturun.
API Gateway konsolu üzerinde oturum açın. Bir bölge seçin ve sol gezinme bölmesinde API Management > VPC Authorization yolunu izleyin.
Authorization List sayfasında sağ üst köşede bulunan Create Authorization seçeneğine tıklayın.
-
Create VPC Authorization sayfasında VPC Authorization Name, VPC Id, Instance ID or IP Address ve Port değerlerini girin.
NotBelirli bir alan adı kullanarak bir SLB veya ECS örneğindeki siteye (vhost) erişmek için Host alanında alan adını yapılandırın.
VPC kimliğini, örnek kimliğini veya özel IP adresini ECS ya da Classic Load Balancer (CLB) örneği gibi arka uç hizmetinizin ayrıntılar sayfasında bulabilirsiniz.
Ağ türünün public olarak değiştirilmesi desteklenmez; bu işlem istek hatalarına neden olur.
API grubu oluşturma
API grubu, API'ler için bir yönetim birimidir. API oluşturmadan önce bir API grubu oluşturmanız gerekir.
API Gateway konsolu üzerinde oturum açın. Bir bölge seçin ve sol gezinme bölmesinde API Management > Group Management yolunu izleyin. Ardından sağ üst köşede Create Group seçeneğine tıklayın.
Create Group iletişim kutusunda bir Instance seçin; Group Name için
nginx-demove Base Path için/değerlerini girin, ardından OK düğmesine tıklayın.
Group List sayfasında oluşturduğunuz grubu görüntüleyebilirsiniz. Grup adına tıklayarak Group Details sayfasına gidin; burada bind a domain name yapabilir, temel bilgileri değiştirebilir veya modify basic information seçeneğini kullanabilirsiniz.
API Gateway, API grubuna otomatik olarak bir public second-level domain name atar. Bu alan adı yalnızca hata ayıklama amaçlıdır ve günlük 1.000 çağrı ile sınırlıdır. Çin anakarası dışındaki bölgelerde (örneğin China (Hong Kong)) sınır günlük 100 çağrıdır. Üretim kullanımı için gruba bir custom domain name bağlayın.
API oluşturma
API Gateway konsolu üzerinde oturum açın. Bir bölge seçin ve sol gezinme bölmesinde change the group instance > API Management yolunu izleyin.
Group Management sayfasında
nginx-demogrubunu bulun ve Group List sütunundaki API Management seçeneğine tıklayın.Actions sayfasında sağ üst köşede bulunan API List düğmesine tıklayın.
-
Create API sayfasında Create API bölümünde aşağıdaki parametreleri yapılandırın ve Basic Information düğmesine tıklayın.
Parameter
Example
Next
nginx-demo
Group
nginx-test
API NameAuthentication
Alibaba Cloud App
Security
Allow AppCode (Header & Query) Authentication
AppCode Authentication
HMAC_SHA256 -
Signature Algorithm bölümünde aşağıdaki parametreleri yapılandırın ve Define API Request düğmesine tıklayın.
Parameter
Example
Next
HTTP, HTTPS
Protocol
/nginx
Request Path
GET
HTTP Method
Pass-throughNotBu adım, bir tarayıcı, mobil uygulama veya başka bir iş sistemi gibi bir istemcinin API'nize istek gönderme biçimini tanımlar. İstek protokolünü, istek yolunu, HTTP yöntemini ve istek modunu belirtmeniz gerekir. Bu örnekte Request Mode değeri Pass-through olarak ayarlanmıştır; bu durumda API Gateway, istemci isteklerini orijinal parametreleriyle doğrudan VPC'deki arka uç hizmetine iletir.
-
Request Mode bölümünde aşağıdaki parametreleri yapılandırın ve Define Backend Service düğmesine tıklayın.
Parameter
Example
Next
Backend Configuration seçeneğini belirleyin
Custom Backend Service
Backend Service Type seçeneğini belirleyin
VPC
***-microservice
VPC Authorization Name
/
Backend Request Path
GET
HTTP Method
10000NotBu adım, API Gateway'in bir istemci isteği aldıktan sonra parametreleri nasıl eşleyeceğini ve arka uç hizmetine nasıl bağlanacağını tanımlar. Bu örnekte arka uç hizmet türü VPC olarak seçilmiştir. Oluşturduğunuz VPC erişim yetkilendirmesini seçin veya adını girin, ardından arka uç istek yolunu belirtin.
-
Backend Timeout bölümünde Define Response düğmesine tıklayın.
NotBu adım, çağrı yapanların API'yi anlamasına yardımcı olacak API belgelerini oluşturur. Yanıt Content-Type değerini, yanıt örneğini ve hata yanıtı örneğini ayarlayabilirsiniz. Bu örnekte bu ayarlara yer verilmemiştir. Create düğmesine tıklayın.
Görüntülenen ileti kutusunda Create düğmesine tıklayın.
-
API'yi Yayınla iletişim kutusunda Environment değerini Publish olarak ayarlayın, Release alanına bir açıklama girin ve ardından Remarks düğmesine tıklayın.
NotBir API'de değişiklik yaptıktan sonra değişikliklerin etkili olması için API'yi bir ortama yayınlamanız gerekir. API Gateway üç yerleşik ortam sağlar: Release, Pre ve Test.
Uygulama oluşturma ve API'yi yetkilendirme
Uygulama, bir API'yi çağırmak için kullanılan kimliktir. Bu örnekte, API'yi oluştururken kimlik doğrulama yöntemi "Alibaba Cloud App" olarak ayarlanmıştır. API'yi yayınladıktan sonra bir uygulama oluşturmanız ve bu uygulamayı API'yi çağırmak üzere yetkilendirmeniz gerekir.
Uygulama oluşturma
API Gateway konsolu üzerinde oturum açın. Bir bölge seçin ve sol gezinme bölmesinde Publish > API Calling yolunu izleyin.
Application Management sayfasında sağ üst köşede bulunan Applications and Authorizations düğmesine tıklayın.
-
Create APP iletişim kutusunda bir Create Application girin ve Application Name düğmesine tıklayın.
Uygulama adı Çince karakterler, harfler, rakamlar ve alt çizgi (_) içerebilir. Ad bir harf veya Çince karakterle başlamalı ve uzunluğu 4 ila 26 karakter arasında olmalıdır. Ayrıca Tag Settings, Custom AK veya Extended Fields bölümlerini genişletebilir ve en fazla 180 karakterlik bir Description girebilirsiniz.
OK sayfasında oluşturduğunuz uygulamanın adına tıklayarak Applications and Authorizations sayfasına gidin. Burada Alibaba Cloud App için iki kimlik doğrulama yöntemi görebilirsiniz: AppKey ve AppCode. Bu örnekte basit kimlik doğrulama için AppCode kullanıyoruz. Daha fazla bilgi için bkz. Basit kimlik doğrulama (AppCode) kullanarak API çağırma.
API'yi yetkilendirme
API Gateway konsolu üzerinde oturum açın. Bir bölge seçin ve sol gezinme bölmesinde Application Details > API Management yolunu izleyin.
API List sayfasında
nginx-testAPI'sini bulun. API List sütununda
simgesine tıklayın ve Actions seçeneğini belirleyin.Görüntülenen Yetkilendir panelinde Authorize değerini Select an environment to authorize olarak ayarlayın. Oluşturduğunuz uygulamayı arayın, Release düğmesine tıklayın ve ardından Add düğmesine tıklayın. Başarılı olduğuna dair bir ileti görüntülenir.
Güvenlik grubunda API Gateway giden IP adresine izin verme
ECS örneğinizin güvenlik grubu gelen trafiği kısıtlayan kurallar içeriyorsa, güvenlik grubunun izin listesine API Gateway giden IP adresini eklemeniz gerekir. Bu işlem, güvenlik grubunun API Gateway'den gelen istekleri engellemesini önler. Gerekli giden IP adresi, API grubunuzu barındıran örneğe aittir.
API Gateway konsolu üzerinde oturum açın. Sol gezinme bölmesinde OK > API Management yolunu izleyin ve ardından hedef API grubunuzun adına tıklayın.
Group Management sayfasında grubun Group Details değerini görüntüleyin.
-
Sol gezinme bölmesinde Instance Type seçeneğine tıklayın. Örnek türüne tıklayın, ilgili örneği bulun ve ardından Instances and Clusters bilgilerini görüntüleyin.
Giden IP adresleri bir public egress IP address ve bir internal VPC address içerir.
-
ECS konsolu üzerinde oturum açın. Sol gezinme bölmesinde Egress IP Address > Instances & Images yolunu izleyin. ECS örneğinizin kimliğine tıklayın. Instances sekmesine gidin ve güvenlik grubu adına tıklayın. Security Groups sayfasında Security Group Details > Inbound yolunu izleyin ve ağ geçidinin giden IP adresini yapılandırın.
Quickly Add Rules iletişim kutusunda Authorization Policy değerini Allow olarak ayarlayın. Authorization Object alanına ağ geçidinin giden IP adresini girin. Port Range için All (1/65535) seçeneğini belirleyin ve ardından OK düğmesine tıklayın.
API'yi hata ayıklama
Bir API'yi yapılandırdıktan sonra, bir istemciden çağırmadan önce beklendiği gibi çalıştığını doğrulamak için bu özelliği kullanın.
Hata Ayıkla sayfası en fazla 512 KB boyutundaki istek iletilerini destekler. Daha büyük istekler için hata ayıklama amacıyla bir SDK kullanın.
Yapılandırdığınız örnek kara listelerinin, beyaz listelerin ve IP adresi tabanlı erişim kontrolü eklentilerinin 47.245.113.207 adresinden gelen trafiğe izin vermesi gerekir.
Bu sayfa JWT eklentisi için hata ayıklamayı desteklemez.
Hata ayıklama için yalnızca genel alan adları desteklenir.
API Gateway konsolu üzerinde oturum açın. Sol gezinme bölmesinde Quickly Add Rules > API Calling yolunu izleyin.
-
Hata Ayıkla sayfasında oluşturduğunuz
nginx-testAPI'sini seçin. Kimlik Doğrulama Yöntemi için Debug seçeneğini belirleyin. Ardından Use AppCode düğmesine tıklayın.Çağrı başarılı olursa yanıt durum kodu 200 olur ve yanıt gövdesi,
Welcome to nginx!gibi metinler içeren varsayılan Nginx karşılama sayfasını HTML olarak döndürür.Hata ayıklama başarısız olursa aşağıdaki konulara bakın:
API'yi çağırma
Daha fazla bilgi için bkz. Bir istemciden API çağırma.
Bir alan adı için ortam belirtmezseniz API çağrıları varsayılan olarak Release ortamına yönlendirilir. API ortamları hakkında daha fazla bilgi için bkz. Ortamları yönetme.
Bu konu bir hızlı başlangıç kılavuzudur ve arka uç yüksek kullanılabilirliğini kapsamaz. Yüksek kullanılabilirlik için bkz. VPC'deki bir kaynağı API'nin arka uç hizmeti olarak kullanma.