Tüm Ürünler
Search
Belge Merkezi

API Gateway:Simple Log Service ile API çağrı günlüklerini görüntüleyin

Son Güncelleme:Oct 04, 2026

API Gateway, Simple Log Service (SLS) ile sorunsuz bir şekilde entegre olur. SLS'yi kullanarak günlükleri gerçek zamanlı olarak sorgulayabilir, indirebilir ve çok boyutlu istatistiksel analizler yapabilirsiniz. Ayrıca günlükleri Object Storage Service (OSS) veya MaxCompute hizmetine aktarabilirsiniz.

Özellikler

Çevrimiçi günlük sorgulama

Bu özellik, sorun giderme ve istatistiksel analiz için kullanışlıdır.

Ayrıntılı çağrı günlükleri

Günlükler aşağıdaki alanları içerir: requestQueryString, requestHeaders, requestBody, responseHeaders ve responseBody alanları yalnızca özel örneklerde mevcuttur ve grup ayrıntıları sayfasından etkinleştirilmelidir.

Parametre

Açıklama

apiGroupUid

API grubunun ID'si.

apiGroupName

API grubunun adı.

apiUid

API'nin ID'si.

apiName

API'nin adı.

apiStageUid

Ortamın ID'si.

apiStageName

Ortamın adı.

httpMethod

Çağrı için kullanılan HTTP yöntemi.

path

İstek yolu.

domain

Çağrı için kullanılan alan adı.

statusCode

HTTP durum kodu.

errorMessage

Hata mesajı.

appId

Çağrıyı yapan uygulamanın ID'si.

appName

Çağrıyı yapan uygulamanın adı.

clientIp

İstemcinin IP adresi.

exception

Arka uç hizmetinden gelen belirli hata mesajı.

exchangeTimestamp

İstek yaşam döngüsündeki G/Ç olaylarının zaman damgaları.

  • FrontRequestStart: API Gateway'in istemci isteğini almaya başladığı zaman.

  • FrontRequestEnd: API Gateway'in istemci isteğini almayı tamamladığı zaman.

  • BackendRequestStart: API Gateway'in isteği arka uç hizmetine göndermeye başladığı zaman.

  • BackendRequestEnd: API Gateway'in isteği arka uç hizmetine göndermeyi tamamladığı zaman.

  • BackendResponseStart: API Gateway'in arka uç hizmetinden yanıtı almaya başladığı zaman.

  • BackendResponseEnd: API Gateway'in arka uç hizmetinden yanıtı almayı tamamladığı zaman.

  • FrontResponseStart: API Gateway'in yanıtı istemciye göndermeye başladığı zaman.

  • FrontResponseEnd: API Gateway'in yanıtı istemciye göndermeyi tamamladığı zaman.

providerAliUid

API sağlayıcısının hesap ID'si.

region

Bölge. Örnek: cn-hangzhou.

requestHandleTime

İstek zamanı (UTC).

requestId

Genel olarak benzersiz olan istek ID'si.

requestSize

Bayt cinsinden istek boyutu.

responseSize

Bayt cinsinden yanıt boyutu.

serviceLatency

Bağlantı kaynaklarını ayırmak, bağlantı kurmak ve arka uç hizmetini çağırmak dahil olmak üzere arka uç kaynaklarına erişmek için harcanan toplam süre. Birim: milisaniye.

errorCode

Hata kodu. Örnek: X500ER.

requestProtocol

İstemci istek protokolü. Geçerli değerler: HTTP, HTTPS ve WS.

instanceId

API hizmetinin çalıştığı örneğin ID'si.

initialRequestId

Bir API başka bir API'yi çağırıyorsa (örneğin, API-1, API-2'yi çağırır), bu alan ikinci çağrının (API-2) günlüğünde ilk çağrının (API-1) istek ID'sini kaydeder.

clientNonce

İstemci isteğinin X-Ca-Nonce üstbilgisi.

requestQueryString

İstemci isteğinin sorgu dizesi (yalnızca özel örnekler).

requestHeaders

İstemci isteğinin üstbilgileri (yalnızca özel örnekler).

requestBody

İstemci isteğinin gövdesi, en fazla 1.024 bayt (yalnızca özel örnekler).

responseHeaders

API yanıtının üstbilgileri (yalnızca özel örnekler).

responseBody

API yanıtının gövdesi, en fazla 1.024 bayt (yalnızca özel örnekler).

consumerAppKey

API isteğinin AppKey değeri.

totalLatency

API isteğinin milisaniye cinsinden toplam gecikme süresi.

customTraceId

Uçtan uca günlüğün izleme ID'si.

jwtClaims

JSON Web Token (JWT) öğesinden ayrıştırılan talepler. Bu özelliği API grubu ayarlarında yapılandırabilirsiniz.

plugin

API isteğiyle eşleşen eklentilerin listesi ve ilgili bağlam.

Simple Log Service ile API günlüklerini görüntüleyin

Yapılandırma yöntemleri

Kullanılabilen iki yapılandırma yöntemi vardır:

  1. SLS konsolundaki Log Audit özelliğini kullanarak API Gateway günlüklerini senkronize edin. Bu yöntemle, tüm bölgelerdeki günlükler Log Audit projesinde toplanır. API Gateway'de ek bir yapılandırma gerekmez.

  2. SLS konsolunda API Gateway için veri alımını yapılandırın. Bu yöntemle, her bölge için senkronizasyonu ayrı ayrı yapılandırmanız gerekir.

Aşağıdaki bölümlerde bu iki yöntem açıklanmaktadır.

Not

Alibaba Gov Cloud ve Alibaba Finance Cloud için SLS günlüklerini yalnızca ilk yöntemi kullanarak senkronize edebilirsiniz.

Log Audit kullanma

  1. Log Audit Service yapılandırma sayfasını açın ve sonraki tüm API Gateway günlüklerinin teslim edileceği merkezi bir bölge seçin.

    Global Configurations sayfasının üst kısmında merkezi projenin bölgesi ve adı gösterilir. Alt kısımda ise ActionTrail, Object Storage Service (OSS), RDS, Virtual Private Cloud (VPC), DNS, PolarDB, Server Load Balancer (SLB) ve Application Load Balancer (ALB) gibi cloud ürünlerine ait yapılandırma öğelerini içeren bir tablo bulunur. Bu öğeler arasında günlük toplama anahtarı, Storage Mode (Centralized veya By Region), saklama süresi, Sync To Center ve Archive After N Days yer alır. Gerekli cloud ürünleri için günlük toplama anahtarlarını etkinleştirin ve ardından sağ üst köşedeki Save düğmesine tıklayın. Collection and Synchronization Authorization bölümünde, hesabın günlükleri toplamak ve senkronize etmek için yetkilendirilmediğine dair bir mesaj görürseniz manual authorization veya Authorize with AccessKey seçeneklerini kullanarak yetkilendirmeyi tamamlayın.

  2. Bir yetkilendirme yöntemi seçin ve ekrandaki talimatları izleyin. Bu örnekte manuel yetkilendirme kullanılmaktadır.

  3. Yetkilendirme tamamlandıktan sonra API Gateway çağrı günlükleri, merkezi proje içindeki apigateway_log Logstore alanında kullanılabilir hale gelir.

    API Gateway çağrı günlükleri; apiGroupName, apiGroupUid, apiName, apiStageName, apiStageUid ve apiUid gibi alanları içerir. Her günlük girdisi için ayrıntılı anahtar-değer çiftlerini Raw Logs sekmesinde görüntüleyebilirsiniz.

API Gateway konsolunda yapılandırma

1) SLS'yi etkinleştirdiğinizden emin olun. Ardından SLS console oturumunu açın, hedef bölgeyi seçin ve bir proje ile bir Logstore oluşturun. Bu örnekte China (Hangzhou) bölgesi kullanılmıştır.

Create Project iletişim kutusunda bir Project Name girin (örneğin, gateway-t***), varsayılan resource group değerini koruyun ve Enable Logging for bölümünde Operation Log ve Global Log gibi tercihlerinizi belirleyin. Ardından Tamam'a tıklayın. Proje oluşturulduktan sonra açılan iletişim kutusunda Create Logstore seçeneğine tıklayın. Logstore oluştururken ayarlarını yapılandırın. Örneğin, Logstore Name değerini gateway_log olarak, Type değerini Standard olarak, Billing Mode değerini Pay-By-Data-Written olarak, Data Retention Period değerini 30 gün olarak ve Number of Shards değerini 2 olarak ayarlayın. Auto Split Shard (en fazla 64 parça) ve Log Public IP seçeneklerini etkinleştirin ve ardından OK düğmesine tıklayın. Son onay iletişim kutusunda Data Import Wizard seçeneğine tıklayın.

2) API Gateway veri alımını yapılandırın ve API Gateway ürününü seçin.

API Gateway'i seçtikten sonra Data Source Configuration sayfası görünür. RAM authorization işleminin tamamlandığını doğrulayın (sayfada "You have authorized Log Service to distribute logs" ifadesi görüntülenir). Create Distribution Rule bölümünde API Gateway erişim günlüklerinin hedef Logstore alanına aktarıldığını doğrulayın ve ardından Next düğmesine tıklayın. Yapılandırmayı tamamlamak için kalan adımlarda Next düğmesine tıklamaya devam edin.

Günlükleri görüntüleme

Günlükleri görüntülemek ve SLS sorgu sözdizimini kullanarak çağrı günlüklerinde arama yapmak için SLS konsolunda oturum açın.

Sorgu sonuçlarında her günlük girdisi; apiGroupName, apiGroupUid, apiName, __source__, __tag__:__receive_time__ ve __topic__ gibi alanları içerir. Sol taraftaki Quick Analysis bölmesinde alana göre günlükleri filtreleyebilir veya kesin aramalar yapmak için üstteki arama kutusunda sorgu sözdizimini kullanabilirsiniz.

Özel sorgu raporları oluşturma

İş ihtiyaçlarınıza göre özel sorgu raporları oluşturabilirsiniz. Talimatlar için bkz. Pano oluşturma.