Error Server Internal 500 - BadPath

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.BadPath 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":"Invalid request path",
      "detail":{
         "errorcode":"protocol.http.BadPath"
      }
   }
}

Kemungkinan penyebab

Error ini terjadi jika URL permintaan server backend, yang diwakili oleh variabel alur target.url, berisi path yang dimulai dengan tanda tanya (?), bukan garis miring (/), yang tidak valid.

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 dimulai dengan dan selalu memiliki garis miring (/).

Oleh karena itu, jika URL permintaan server backend memiliki komponen path yang dimulai dengan tanda tanya (?) dan bukan garis miring (/), maka Apigee Edge akan merespons dengan 500 Internal Server Error dan kode error protocol.http.BadPath.

Misalnya: Jika target.url memiliki nilai https://www.mocktarget.apigee.net?json, maka error ini terjadi karena path ditemukan tidak valid, karena dimulai dengan tanda tanya (?) dan bukan garis miring (/).

Langkah-langkah diagnosis umum

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

Penyebab: URL server backend (target.url) memiliki jalur yang tidak valid

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.BadPath dan Fault Source memiliki nilai target, maka ini menunjukkan bahwa URL server backend memiliki jalur yang tidak valid.

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

4. Tentukan apakah variabel alur target.url memang memiliki jalur tidak valid dan sumber nilainya menggunakan salah satu metode berikut:

   Trace

   Menggunakan alat Trace

   Jika Anda telah merekam aktivitas pelacakan untuk error ini, gunakan langkah-langkah seperti yang dijelaskan dalam Menggunakan alat Trace dan

   1. Verifikasi apakah target.url memiliki jalur yang tidak valid, yaitu apakah jalur tersebut dimulai dengan tanda tanya (?) dan bukan garis miring (/).

   2. Jika ya, temukan kebijakan yang mengubah atau memperbarui nilai target.url agar berisi jalur yang tidak valid.

      Contoh rekaman aktivitas yang menunjukkan kebijakan JavaScript memperbarui variabel alur target.url

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

      Jalur dimulai dengan tanda tanya (?) dan bukan garis miring (/), sehingga tidak valid.

   Log

   Menggunakan log di server log Anda

   1. Jika Anda tidak memiliki trace untuk error ini (masalah sementara), periksa 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 yang tidak valid, dan
      2. Lihat apakah Anda dapat menentukan informasi tentang kebijakan mana yang diubah target.url agar berisi jalur yang tidak valid

   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 dengan cermat (Misalnya: AssignMessage atau JavaScript) yang mengubah atau memperbarui flow variable target.url dan tentukan penyebab pembaruan target.url agar memiliki jalur yang tidak valid.

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

   Contoh #1

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

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

   Pada contoh di atas, perhatikan bahwa flow variable target.url diperbarui dengan nilai https://mocktarget.apigee.net?json yang ada dalam variabel url. lainnya

   Perhatikan bahwa nilai url memiliki komponen berikut:

   • skema: https
   • authority: mocktarget.apigee.net
   • path: ?json

   Jalur dimulai dengan tanda tanya (?) dan bukan garis miring (/), yang tidak valid. Oleh karena itu, Apigee Edge menampilkan 500 Internal Server Error dengan kode error protocol.http.BadPath.

   Contoh #2

   Contoh #2: Kebijakan JavaScript memperbarui variabel target.url berdasarkan nilai di header permintaan

   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.

   Permintaan Sampel yang dibuat oleh pengguna

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

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

   Jadi:

   • url = https://mocktarget.apigee.net + path
   • url = https://mocktarget.apigee.net + "?user"
   • target.url = https://mocktarget.apigee.net?user

   Perhatikan bahwa nilai target.url memiliki komponen berikut:

   • skema: https
   • authority: mocktarget.apigee.net
   • path: ?user

   Jalur dimulai dengan tanda tanya (?) dan bukan garis miring (/), yang tidak valid. Oleh karena itu, Apigee Edge menampilkan 500 Internal Server Error dengan kode error protocol.http.BadPath.

   Contoh #3

   Contoh #3: Kebijakan AssignMessage memperbarui variabel target.url

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

   Perhatikan bahwa nilai url memiliki komponen berikut:

   • skema: https
   • authority: mocktarget.apigee.net
   • path: ?echo

   Sekali lagi dalam contoh ini, jalur dimulai dengan tanda tanya (?) bukan garis miring (/), yang tidak valid. Oleh karena itu, Apigee Edge menampilkan 500 Internal Server Error dengan kode error protocol.http.BadPath.

Resolusi

Sesuai spesifikasi URL RFC 3986, bagian 3: Komponen Sintaksis, komponen path diperlukan dan HARUS selalu dimulai dengan "/". Jadi, ikuti langkah-langkah di bawah untuk memperbaiki masalah ini:

1. Pastikan URL server backend, yang diwakili oleh flow variable target.url selalu memiliki jalur yang valid dan selalu dimulai dengan garis miring (/).
   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 yang tidak valid.
   3. Jika Anda melakukan operasi string apa pun untuk menentukan nilai flow variable target.url, pastikan hasil atau keluaran operasi string tidak memiliki jalur tidak valid.

2. Dalam contoh yang dibahas di atas, Anda dapat memperbaiki masalah ini seperti yang dijelaskan di bawah:

   Contoh #1

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

   Gunakan garis miring (/) dan bukan tanda tanya (?) di variabel url untuk memperbaiki masalah ini seperti yang ditunjukkan di bawah:

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

   Contoh #2

   Contoh #2: Kebijakan JavaScript memperbarui variabel target.url berdasarkan nilai di header permintaan

   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: /user 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: /user"
   

   Contoh #3

   Contoh #3: Kebijakan AssignMessage memperbarui variabel target.url

   Tambahkan jalur yang valid dalam elemen <Value> kebijakan AssignMessage. Artinya, ganti tanda tanya (?) dengan garis miring ke depan (/) di elemen <Value> dan tetapkan ke https://mocktarget.apigee.net/echo untuk memperbaiki masalah ini 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/echo</Value>
       </AssignVariable>
       <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
       <AssignTo createNew="false" transport="http" type="request"/>
   </AssignMessage>

   Spesifikasi

   Apigee Edge mengharapkan bahwa path komponen di URL server backend HARUS selalu dimulai dengan garis miring (/) sesuai dengan spesifikasi berikut:

   Spesifikasi
   RFC 3986, bagian 3: Komponen Sintaksis
   RFC 3986, bagian 3.3: Path

   Jika Anda masih memerlukan bantuan dari Dukungan Apigee, buka Mengumpulkan informasi diagnostik yang diperlukan.

   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.BadPath
   • 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

   Variabel Alur - target