Topik ini menjelaskan bidang log akses API Gateway.
Bidang | Deskripsi |
apiGroupUid | ID grup tempat API berada. |
apiGroupName | Nama grup tempat API berada. |
apiUid | ID API. |
apiName | Nama API. |
apiStageUid | ID lingkungan di mana API dipanggil. |
apiStageName | Nama lingkungan. |
httpMethod | Metode HTTP yang digunakan oleh permintaan API. |
path | Jalur permintaan API. |
domain | Nama domain yang digunakan untuk pemanggilan API. |
statusCode | HttpStatusCode |
errorMessage | Pesan kesalahan yang dikembalikan. |
appId | ID aplikasi yang digunakan untuk memanggil API. |
appName | Nama aplikasi yang digunakan untuk memanggil API. |
clientIp | Alamat IP klien yang memulai pemanggilan API. |
exception | Pesan kesalahan spesifik yang dikembalikan oleh layanan backend API. |
exchangeTimestamp | Titik waktu I/O dalam tautan permintaan.
|
providerAliUid | ID akun yang menyediakan API. |
region | Wilayah tempat API berada, misalnya cn-hangzhou, yang menunjukkan wilayah China (Hangzhou). |
requestHandleTime | Titik waktu dalam UTC saat permintaan API diterima oleh API Gateway. |
requestId | ID permintaan. ID ini unik secara global. |
requestSize | Ukuran permintaan. Satuan: byte. |
responseSize | Ukuran respons. Satuan: byte. |
serviceLatency | Total waktu yang dikonsumsi untuk mengakses sumber daya backend. Total waktu mencakup waktu yang dikonsumsi untuk meminta koneksi ke sumber daya, waktu yang dikonsumsi untuk membangun koneksi, dan waktu yang dikonsumsi untuk memanggil layanan backend. Satuan: milidetik. |
errorCode | Kode kesalahan, seperti X500ER. |
requestProtocol | Protokol yang digunakan oleh klien untuk mengirim permintaan. Nilai valid: HTTP, HTTPS, dan WS. |
instanceId | ID instance API Gateway tempat API berada. |
initialRequestId | Jika sebuah API memanggil API lain, misalnya, API-1 memanggil API-2, initialRequestId digunakan untuk mencatat ID permintaan API-1 dalam log API-2. |
clientNonce | Header X-Ca-Nonce dalam permintaan yang berasal dari klien. |
requestQueryString | queryString dalam permintaan yang berasal dari klien. Bidang ini hanya untuk instance khusus. |
requestHeaders | Konten header dalam permintaan yang berasal dari klien. Bidang ini hanya untuk instance khusus. |
requestBody | Badan permintaan yang dikirim oleh klien. Badan dapat berisi hingga 1.024 byte panjangnya. Bidang ini hanya untuk instance khusus. |
responseHeaders | Konten header dari respons API. Bidang ini hanya untuk instance khusus. |
responseBody | Konten respons. Respons dapat berisi hingga 1.024 byte panjangnya. Bidang ini hanya untuk instance khusus. |
consumerAppKey | AppKey yang digunakan dalam permintaan. |
totalLatency | Total latensi permintaan API. Satuan: milidetik. |
customTraceId | traceId log ujung ke ujung. |
jwtClaims | Klaim JSON web token (JWT). Klaim dapat dikonfigurasi pada tingkat grup. |
plugin | Plugin yang terkena oleh permintaan dan konteks terkait. |