Error Server Internal 500 - BadFormData

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.BadFormData 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":"Bad Form Data",
      "detail":{
         "errorcode":"protocol.http.BadFormData"
      }
   }
}

Data formulir

Sebelum masuk ke detail pemecahan masalah ini, mari kita pahami apa itu data formulir.

Data formulir adalah informasi yang disediakan oleh pengguna, biasanya melalui formulir HTML yang memiliki elemen seperti kotak input teks, tombol, atau kotak centang. Data formulir umumnya dikirim sebagai serangkaian pasangan nilai kunci sebagai bagian dari permintaan atau respons HTTP.

Membentuk transmisi data

1. Content-Type: application/x-www-form-urlencrypted
   • Jika ukuran data formulir kecil, data akan dikirim sebagai pasangan nilai kunci dengan:
     • Karakter pada kedua kunci yang dikodekan sesuai dengan aturan yang dijelaskan dalam Formulir - Bagian 17.13.4.1
     • Header Content-Type: application/x-www-form-urlencoded

     Contoh permintaan dengan data formulir:

     curl https://HOSTALIAS/somepath -H "Content-Type: application/x-www-form-urlencoded" -d "username=abc@google.com&pasword=secret123"
     

   • Karakter non-alfanumerik apa pun di kunci dan nilai persen dienkodekan, artinya, diwakili sebagai triplet karakter %HH, yang terdiri dari tanda persen diikuti dengan dua digit heksadesimal yang mewakili kode ASCII dari karakter tertentu.
   • Jadi, meskipun tanda persen (%) diizinkan dalam data formulir, ditafsirkan sebagai awal dari urutan escape khusus. Oleh karena itu, jika data formulir perlu berisi tanda persen (%) dalam kunci atau nilai, maka harus dikirimkan sebagai %25, yang mewakili kode ASCII untuk tanda persen (%) karakter.
2. Jenis-Konten: multibagian/formulir-data

   Jika Anda ingin mentransmisikan data biner dalam jumlah besar atau teks yang berisi data non-ASCII karakter, maka Anda dapat mengirim data dengan Content-Type: multibagian/formulir-data seperti yang dijelaskan dalam Formulir - Bagian 17.13.4.2

Kemungkinan penyebab

Error ini terjadi jika dan hanya jika semua kondisi berikut terpenuhi:

1. Permintaan HTTP yang dikirim oleh klien ke Apigee Edge berisi:
   1. Content-Type: application/x-www-form-urlencoded, dan
   2. Formulir data dengan tanda persen (%), atau tanda persen (%) diikuti dengan karakter heksadesimal tidak valid yang tidak diizinkan sesuai Formulir - Bagian 17.13.4.1.

2. Proxy API di Apigee Edge membaca parameter formulir tertentu yang berisi karakter apa pun yang tidak diizinkan untuk digunakan dalam alur permintaan menggunakan ExtractVariables atau Kebijakan TetapkanMessage.

   Misalnya, jika data formulir berisi tanda persen (%) apa adanya (tanpa encoding) atau tanda persen (%) yang diikuti dengan heksadesimal yang tidak valid karakter di kunci dan/atau nilai, maka Anda akan mendapatkan pesan {i>error<i} ini.

   Berikut adalah kemungkinan penyebab error ini:

   Penyebab	Deskripsi	Petunjuk pemecahan masalah berlaku untuk
   Parameter Formulir yang diminta berisi karakter yang tidak diizinkan	Parameter formulir yang diteruskan sebagai bagian permintaan HTTP oleh klien berisi karakter yang tidak diizinkan untuk digunakan.	Pengguna Edge Public dan Private Cloud

Langkah-langkah diagnosis umum

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

Penyebab: Parameter formulir yang diminta memiliki karakter yang tidak diizinkan

Diagnosis

1. Tentukan Kode Kesalahan, Sumber Kesalahan, dan Kebijakan Kesalahan untuk 500 Internal Server Error menggunakan Pemantauan API, alat Trace, atau log akses NGINX seperti yang dijelaskan di Langkah-langkah diagnosis umum.
2. Jika Kode Kesalahan adalah protocol.http.BadFormData, Sumber Kesalahan memiliki nilai proxy atau policy, dan Kebijakan Kesalahan bukan kosong, berarti kebijakan yang ditentukan dalam Kebijakan Kesalahan gagal saat membaca atau mengekstrak data formulir (parameter formulir).
3. Periksa kebijakan yang ditunjukkan dalam Kebijakan Kesalahan dan tentukan informasi:
   1. Sumber: Tentukan apakah kebijakan membaca atau mengekstrak data dari permintaan atau respons.
   2. Parameter formulir: Menentukan parameter formulir tertentu yang sedang dibaca dalam lebih lanjut.

      Contoh #1

      Contoh #1: Parameter formulir ekstraksi kebijakan ExtractVariables:

            <ExtractVariables name="EV-ExtractFormParms">
               <DisplayName>EV-ExtractFormParams</DisplayName>
               <Source>request</Source>
               <FormParam name="username">
                  <Pattern ignoreCase="false">{username}</Pattern>
               </FormParam>
               <FormParam name="password">
                 <Pattern ignoreCase="false">{password}</Pattern>
               </FormParam>
               <VariablePrefix>forminfo</VariablePrefix>
             <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
            </ExtractVariables>
            

      Dalam kebijakan ExtractVariables di atas:

      • Sumber: request

        Hal ini ditunjukkan oleh elemen <Source>

      • Parameter formulir: username dan password

        Hal ini ditunjukkan oleh elemen <Pattern> dalam Elemen <FormParam>

      Ini menunjukkan bahwa parameter formulir username dan/atau password diteruskan sebagai bagian dari permintaan HTTP oleh klien ke Apigee Edge berisi karakter yang tidak diizinkan untuk digunakan.

      Contoh #2

      Contoh #2: Parameter formulir penyalinan kebijakan TetapkanMessage:

            <AssignMessage continueOnError="false" enabled="true" name="AM-CopyFormParams">
              <Copy source="request">
                <FormParams>
                  <FormParam name="username"/>
                  <FormParam name="password"/>
                </FormParams>
              </Copy>
              <AssignTo createNew="true" transport="http" type="request"/>
            </AssignMessage>
            

      Dalam kebijakan ExtractVariables di atas:

      • Sumber: request

        Hal ini ditunjukkan dengan atribut source di Elemen <Copy>

      • Parameter formulir: username dan password

        Hal ini ditunjukkan dengan atribut name di Elemen <FormParam>

      Ini menunjukkan bahwa parameter formulir username atau password atau keduanya diteruskan sebagai bagian dari permintaan HTTP oleh klien ke Apigee Edge berisi karakter yang tidak diizinkan untuk digunakan.

4. Periksa untuk melihat apakah ada karakter yang tidak diizinkan untuk digunakan menggunakan karakter dalam parameter formulir yang diidentifikasi pada langkah 3 menggunakan salah satu metode berikut:

   Alat rekaman aktivitas

   Untuk memvalidasi menggunakan alat Trace:

   1. Jika Anda telah merekam pelacakan permintaan yang gagal seperti yang dijelaskan dalam Langkah-langkah diagnosis umum, lalu pilih salah satu permintaan yang gagal.
   2. Jika Anda telah menentukan bahwa parameter formulir yang berisi karakter apa pun yang tidak diizinkan untuk digunakan adalah bagian dari permintaan HTTP di langkah 3 di atas, lalu
      1. Buka fase Permintaan Diterima dari Klien.

      2. Scroll ke bawah ke bagian Detail Fase dan tinjau Minta Konten.

         ( lihat gambar yang lebih besar)

         
      3. Pada contoh di atas, perhatikan bahwa parameter formulir password berisi tanda persen (%).
      4. Karena tanda persen (%) juga digunakan untuk encoding persen karakter khusus, karakter khusus ini tidak dapat digunakan apa adanya data formulir.
      5. Oleh karena itu, Apigee Edge merespons dengan 500 Internal Server Error dengan kode error protocol.http.BadFormData.

   Permintaan sebenarnya

   Untuk memvalidasi menggunakan permintaan yang sebenarnya:

   1. Jika Anda tidak memiliki akses ke permintaan sebenarnya yang dibuat ke server target, lalu buka Resolution.
   2. Jika Anda memiliki akses ke permintaan aktual yang dibuat ke Apigee Edge, lakukan langkah-langkah berikut:
      1. Tinjau konten data formulir dan lihat apakah berisi karakter yang tidak diizinkan untuk digunakan seperti tanda persen (%) atau tanda persen (%) diikuti oleh tanda tidak valid karakter heksadesimal.

         Contoh #1

         Contoh Permintaan #1: Formulir data sebagai bagian dari permintaan

         curl -X GET "https://HOSTALIAS/myproxy -H "Content-Type: application/x-www-form-urlencoded" -d "client_id=123456abc123&client_secret=c23578%ZY"
         

         Dalam contoh ini, perhatikan bahwa elemen client_secret berisi tanda persen (%) diikuti oleh karakter heksadesimal tidak valid ZY.

         Contoh #2

         Contoh Permintaan #2: Data formulir yang diteruskan dalam file:

         curl -X GET "https://HOSTALIAS/myproxy -H "Content-Type: application/x-www-form-urlencoded" -d @form_data.xml
         

         Konten form_data.xml:

         xml=<user><username>abc1234@google.com</username><password>qwerty12345!@#$%</password></user>
         

         Dalam contoh ini, perhatikan bahwa elemen password berisi tanda persen (%), yang seharusnya tidak yang diteruskan apa adanya dalam data formulir.

   3. Dalam dua contoh di atas, data formulir yang dikirim sebagai bagian dari permintaan HTTP ke Apigee Edge berisi karakter yang tidak diizinkan untuk digunakan.
   4. Oleh karena itu, Apigee Edge merespons dengan 500 Internal Server Error dengan kode error protocol.http.BadFormData.

Resolusi

1. Pastikan ada karakter khusus pada kunci dan nilai data formulir atau parameter dikirim sebagai bagian dari permintaan HTTP oleh klien selalu dikodekan seperti yang dijelaskan dalam Data Formulir - application/x-www-form-urlcoded.
2. Untuk contoh yang dibahas di atas, Anda dapat memperbaiki masalah sebagai berikut:

   Contoh #1

   Contoh #1: Data formulir yang diteruskan sebagai bagian dari permintaan:

   Gunakan yang valid karakter heksadesimal yang cocok dengan kode ASCII untuk karakter tertentu. Misalnya, jika Anda ingin mengirim tanda dolar ($), gunakan %24 sebagaimana ditunjukkan di bawah ini:

   curl -X GET "https://HOSTALIAS/myproxy -H "Content-Type: application/x-www-form-urlencoded" -d "client_id=123456abc123&client_secret=c23578%24"
   

   Contoh #2

   Contoh Permintaan #2: Data formulir yang diteruskan dalam file:

   curl -X GET "https://HOSTALIAS/myproxy -H "Content-Type: application/x-www-form-urlencoded" -d @form_data.xml
   

   Konten form_data.xml:

   Gunakan encoding persen untuk tanda persen (%), yaitu mengubah file menjadi %25 seperti yang ditunjukkan di bawah ini:

   xml=<user><username>abc1234@google.com</username><password>qwerty12345!!@#$%25</password></user>
   

Spesifikasi

Apigee Edge mengharapkan data formulir dikirim sesuai dengan spesifikasi berikut:

Spesifikasi
Data Formulir - application/x-www-form-urlencoding

Jika Anda masih memerlukan bantuan dari Dukungan Apigee, buka Harus mengumpulkan diagnostik.

Harus mengumpulkan informasi diagnostik

Jika masalah berlanjut bahkan setelah mengikuti instruksi di atas, kumpulkan informasi diagnostik, lalu hubungi Dukungan Apigee Edge:

Jika Anda adalah pengguna Cloud Publik, berikan informasi berikut:

• Nama organisasi
• Nama lingkungan
• Nama proxy API
• Menyelesaikan perintah curl yang digunakan untuk mereproduksi 500 Internal Server Error dengan kode error protocol.http.BadFormData
• 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

  Di mana: ORG, ENV, dan PORT# diganti dengan nilai aktual.

• Log sistem Pemroses Pesan

  /opt/apigee/var/log/edge-message-processor/logs/system.log

Referensi

• Jenis Konten Formulir
• RFC3986, bagian 2.1: Encoding persen
• Encoding Percent
• Karakter heksadesimal