Error Server Internal 500 - EmptyPath

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

Gejala

Aplikasi klien mendapatkan kode status HTTP 500 Internal Server Error dengan kode error protocol.http.EmptyPath sebagai respons untuk panggilan API.

Pesan error

Aplikasi klien mendapatkan kode respons berikut:

HTTP/1.1 500 Internal Server Error

Selain itu, Anda mungkin melihat pesan error berikut:

{
   "fault":{
      "faultstring":"Request path cannot be empty",
      "detail":{
         "errorcode":"protocol.http.EmptyPath"
      }
   }
}

Kemungkinan penyebab

Error ini terjadi jika URL permintaan server backend, yang diwakili oleh variabel alur target.url, berisi jalur kosong.

Sesuai spesifikasi RFC 3986, bagian 3: Komponen Sintaksis dan RFC 3986, bagian 3.3: Jalur:

1. Sintaksis URI memiliki komponen berikut:

           foo://example.com:8042/over/there?name=ferret#nose
           \_/   \______________/\_________/ \_________/ \__/
            |            |            |            |       |
         scheme      authority       path        query   fragment
   

2. Komponen path wajib dan HARUS selalu memiliki garis miring (/), meskipun tidak ada karakter lain sebagai bagian dari jalur.

Oleh karena itu, jika URL permintaan server backend tidak memiliki komponen path sama sekali, yaitu, bahkan tidak memiliki garis miring (/), maka Apigee Edge akan merespons dengan 500 Internal Server Error dan kode error protocol.http.EmptyPath.

Misalnya: Jika target.url memiliki nilai https://www.mocktarget.apigee.net, maka error ini terjadi karena komponen path kosong atau tidak ada.

Langkah-langkah diagnosis umum

Gunakan salah satu alat/teknik berikut untuk mendiagnosis error ini:

Penyebab: URL server backend (target.url) memiliki jalur kosong

Diagnosis

1. Tentukan Kode Kesalahan dan Sumber Kesalahan untuk 500 Internal Server Error menggunakan Pemantauan API, Alat Trace, atau log akses NGINX seperti yang dijelaskan dalam Langkah-langkah diagnosis umum.
2. Jika Fault Code adalah protocol.http.EmptyPath dan Fault Source memiliki nilai target, hal ini menunjukkan bahwa URL server backend memiliki jalur kosong.

3. URL server backend diwakili oleh flow variable target.url di Apigee Edge. Error ini biasanya terjadi jika Anda mencoba memperbarui URL server backend, yaitu, target.url secara dinamis menggunakan salah satu kebijakan (dalam Proxy/alur bersama) dalam alur permintaan Target, sehingga memiliki jalur kosong.

4. Tentukan apakah variabel alur target.url memang memiliki jalur kosong dan sumber untuk nilainya menggunakan salah satu langkah berikut:

   Trace

   Menggunakan alat Trace

   Jika Anda telah merekam aktivitas pelacakan untuk error ini, gunakan langkah-langkah seperti yang dijelaskan dalam Menggunakan Alat Perekam Aktivitas dan:

   1. Verifikasi apakah target.url memiliki jalur kosong.

   2. Jika ya, cari tahu kebijakan mana yang mengubah atau memperbarui nilai target.url agar berisi jalur kosong.

      Contoh trace yang menunjukkan bahwa kebijakan JavaScript memperbarui flow variable target.url:

      
   3. Dalam rekaman aktivitas contoh di atas, perhatikan bahwa kebijakan JavaScript telah mengubah atau memperbarui nilai target.url agar berisi jalur kosong.
   4. Perhatikan bahwa target.url memiliki komponen berikut:
      • skema: https://mocktarget.apigee.net
      • path: kosong

   Log

   Menggunakan log di server log Anda

   1. Jika Anda tidak memiliki trace untuk error ini (masalah yang terjadi sesekali), periksa untuk melihat apakah Anda telah mencatat informasi tentang nilai flow variable target.url, menggunakan kebijakan seperti MessageLogging atau ServiceCallout ke server log Anda.
   2. Jika Anda memiliki log, tinjau log tersebut dan:
      1. Verifikasi apakah target.url memiliki jalur kosong, dan
      2. Lihat apakah Anda dapat menentukan kebijakan mana yang mengubah target.url agar berisi jalur kosong

   Proxy API

   Meninjau proxy API yang gagal

   Jika Anda tidak memiliki trace atau log untuk error ini, tinjau Proxy API yang gagal untuk menentukan apa yang mengubah atau memperbarui flow variable target.url sehingga berisi jalur yang tidak valid. Periksa hal-hal berikut:

   • Kebijakan dalam proxy API
   • Alur bersama yang dipanggil dari proxy

5. Periksa kebijakan tertentu (misalnya, AssignMessage atau JavaScript) yang mengubah atau memperbarui variabel alur target.url dengan cermat dan tentukan penyebab pembaruan target.url agar memiliki jalur kosong.

   Berikut beberapa contoh kebijakan yang memperbarui flow variable target.url secara salah sehingga berisi jalur kosong yang menyebabkan error ini.

   Contoh #1

   Contoh #1: Pembaruan Kebijakan JavaScript pada variabel target.url

   var url = "https://mocktarget.apigee.net"
   context.setVariable("target.url", url);

   Dalam contoh di atas, perhatikan bahwa variabel alur target.url diperbarui dengan nilai https://mocktarget.apigee.net yang ada dalam variabel lain url.

   Perhatikan bahwa target.url memiliki komponen berikut:

   • skema: https://mocktarget.apigee.net
   • path: kosong

   Karena jalur kosong, Apigee Edge menampilkan 500 Internal Server Error dengan kode error protocol.http.EmptyPath.

   Contoh #2

   Contoh #2: Pembaruan Kebijakan JavaScript pada variabel target.url

   var path = context.getVariable("request.header.Path");
   var url = "https://mocktarget.apigee.net" + path
   context.setVariable("target.url", url);

   Dalam contoh di atas, perhatikan bahwa flow variable target.url diperbarui dengan menggabungkan nilai https://mocktarget.apigee.net yang ada dalam variabel url dan nilai variabel lain path, yang nilainya diambil dari request.header.Path.

   Jika Anda memiliki akses ke permintaan atau rekaman aktivitas yang sebenarnya, Anda dapat memverifikasi nilai sebenarnya yang diteruskan ke request.header.Path.

   Contoh Permintaan yang dibuat oleh pengguna:

   curl -v https://HOST_ALIAS/v1/myproxy -H "Authorization: Bearer <token>
   

   Dalam contoh ini, jalur header tidak dikirim sebagai bagian dari permintaan. Oleh karena itu, nilai jalur variabel dalam kebijakan JavaScript adalah null.

   Jadi:

   • url = https://mocktarget.apigee.net + path
   • url = https://mocktarget.apigee.net + null
   • target.url = https://mocktarget.apigee.netnull

   Perhatikan bahwa target.url memiliki komponen berikut:

   • skema: https://mocktarget.apigee.netnull
   • path: kosong

   Contoh #3

   Contoh #3: Kebijakan AssignMessage memperbarui variabel target.url melalui variabel lain

   <AssignMessage async="false" continueOnError="false" enabled="true" name=">AM-SetTargetURL">
       <DisplayName>AM-SetTargetURL</DisplayName>
       <AssignVariable>
            <Name>target.url</Name>
            <Value>https://mocktarget.apigee.net</Value>
       </AssignVariable>
       <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
       <AssignTo createNew="false" transport="http" type="request"/>
   </AssignMessage>

   Perhatikan bahwa target.url memiliki komponen berikut:

   • skema: https://mocktarget.apigee.net
   • path: kosong

   Dalam semua contoh di atas, jalur di URL server backend, yaitu target.url kosong, sehingga Apigee Edge menampilkan 500 Internal Server Error dengan kode error protocol.http.EmptyPath.

Resolusi

Sesuai spesifikasi RFC 3986, bagian 2: Komponen Sintaksis, komponen path wajib ada dan HARUS selalu memiliki garis miring ke depan (/), meskipun tidak ada karakter lain sebagai bagian dari path. Lakukan langkah-langkah berikut untuk memperbaiki masalah ini:

1. Pastikan URL server backend, yang diwakili oleh flow variable target.url selalu memiliki jalur yang tidak kosong.
   1. Dalam beberapa kasus, Anda mungkin tidak memiliki nama resource di jalur, lalu pastikan jalur setidaknya memiliki garis miring ke depan (/).
   2. Jika Anda menggunakan variabel lain untuk menentukan nilai flow variable target.url, pastikan variabel lain tidak memiliki jalur kosong.
   3. Jika Anda melakukan operasi string apa pun untuk menentukan nilai variabel alur target.url, pastikan hasil atau hasil operasi string tidak memiliki jalur kosong.
2. Dalam contoh yang dibahas di Diagnosis, Anda dapat memperbaiki masalah ini seperti yang dijelaskan di bawah:

   Contoh #1

   Contoh #1: Pembaruan Kebijakan JavaScript pada variabel target.url

   Tambahkan garis miring (/) ke variabel url untuk memperbaiki masalah ini seperti yang ditunjukkan di bawah:

   var url = "https://mocktarget.apigee.net/"
   context.setVariable("target.url", url);

   Contoh #2

   Contoh #2: Pembaruan Kebijakan JavaScript pada variabel target.url

   var path = context.getVariable("request.header.Path");
   var url = "https://mocktarget.apigee.net" + path
   context.setVariable("target.url", url);

   Pastikan Anda meneruskan jalur yang valid, misalnya, /iloveapis sebagai bagian dari header permintaan Path untuk memperbaiki masalah ini seperti yang ditunjukkan di bawah:

   Contoh permintaan:

   curl -v https://HOST_ALIAS/v1/myproxy -H "Authorization: Bearer <token> -H "Path: /iloveapis"
   

   Contoh #3

   Contoh #3: Kebijakan AssignMessage memperbarui variabel target.url melalui variabel lain

   Tambahkan jalur yang valid dalam elemen <Value> kebijakan AssignMessage. Misalnya, Anda dapat menggunakan /json sebagai jalur untuk MockTarget API. Artinya, ubah elemen <Value> menjadi https://mocktarget.apigee.net/json seperti yang ditunjukkan di bawah:

   <AssignMessage async="false" continueOnError="false" enabled="true" name="AM-SetTargetURL">
       <DisplayName>AM-SetTargetURL</DisplayName>
       <AssignVariable>
            <Name>target.url</Name>
            <Value>https://mocktarget.apigee.net/json</Value>
       </AssignVariable>
       <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
       <AssignTo createNew="false" transport="http" type="request"/>
   </AssignMessage>

Spesifikasi

Apigee Edge mengharapkan URL server backend tidak memiliki jalur kosong sesuai dengan spesifikasi berikut:

Jika Anda masih memerlukan bantuan dari Dukungan Apigee, buka Must gather diagnostic information.

Harus mengumpulkan informasi diagnostik

Jika masalah berlanjut bahkan setelah mengikuti petunjuk di atas, kumpulkan informasi diagnostik berikut, lalu hubungi Dukungan Apigee Edge.

Jika Anda adalah pengguna Cloud Publik, berikan informasi berikut:

• Nama organisasi
• Nama lingkungan
• Nama Proxy API
• Perintah curl lengkap yang digunakan untuk mereproduksi 500 Internal Server Error dengan kode error protocol.http.EmptyPath
• File rekaman aktivitas untuk permintaan API

Jika Anda adalah pengguna Private Cloud, berikan informasi berikut:

• Pesan error lengkap yang diamati untuk permintaan yang gagal
• Nama lingkungan
• Paket proxy API
• File rekaman aktivitas untuk permintaan API

• Log akses NGINX:

  /opt/apigee/var/log/edge-router/nginx/ORG~ENV.PORT#_access_log

  Tempat: ORG, ENV, dan PORT# diganti dengan nilai sebenarnya.

• Log sistem Message Processor /opt/apigee/var/log/edge-message- processor/logs/system.log

Referensi