Yang perlu Anda ketahui tentang error kebijakan

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Baca dokumentasi Apigee Edge.

Topik ini menjelaskan struktur error kebijakan dan jenis variabel alur yang ditetapkan saat terjadi error kebijakan. Informasi ini sangat penting jika Anda merancang dan menerapkan penanganan fault untuk proxy Anda.

Topik ini mengasumsikan bahwa Anda memiliki pemahaman umum tentang cara kerja penanganan kesalahan di Apigee, dan bahwa Anda tahu tentang aturan fault. Jika Anda perlu peninjauan, lihat Menangani kesalahan. Informasi di sini juga akan membantu Anda membuka dan menggunakan Referensi error kebijakan.

Tentang respons error kebijakan default

Saat kebijakan menampilkan error, Apigee akan segera memasuki alur error dan menghasilkan pesan error. Pesan yang dihasilkan sistem ini adalah objek JSON yang menyertakan dua bit informasi: errorcode dan faultstring.

Contoh:

{
   "fault":{
      "detail":{
         "errorcode":"steps.extractvariables.SourceMessageNotAvailable"
      },
      "faultstring":"mymessage message is not available for ExtractVariable: ParseJsonResponse"
   }
}

Mari kita uraikan pesan error ini dengan cepat:

errorcode terdiri dari prefix dan error name, sebagai berikut: [prefix].[error_name]. Pada contoh di atas, "steps.extractvariables adalah awalan dan SourceMessageNotAvailable adalah nama error. Awalan memberi tahu Anda jenis kebijakan yang menyebabkan error. Dalam contoh di atas, Anda dapat mengetahui bahwa kebijakan ExtractVariables menghasilkan error dan nama error-nya adalah SourceMessageNotAvailable.

faultstring berisi deskripsi error. String error biasanya mencakup petunjuk untuk membantu Anda menemukan masalah spesifik yang menyebabkan error, seperti nama kebijakan, nama variabel yang belum terselesaikan, atau apa pun yang menyebabkan error tersebut. Misalnya, dalam pesan error di atas, mymessage kebetulan adalah nama variabel pesan yang belum terselesaikan yang dirujuk dalam kebijakan dan ParseJsonResponse adalah nama kebijakan yang memicu error.

Variabel khusus untuk error kebijakan

Saat error kebijakan dipicu, variabel alur khusus error tertentu akan diisi. Variabel ini sangat berguna dalam penanganan kesalahan. Seperti yang dijelaskan dalam Menangani kesalahan, merupakan praktik yang umum untuk menangkap error kebijakan yang dihasilkan sistem dan melakukan tindakan berikutnya seperti membuat respons error kustom. Misalnya, untuk alasan keamanan, Anda mungkin ingin mencegah klien melihat error dan kode status sebenarnya yang ditampilkan Apigee.

Variabel fault.name

Jika kebijakan menampilkan error, variabel alur fault.name akan ditetapkan ke bagian error_name dari kode error (seperti yang dijelaskan di bagian sebelumnya). Sangat umum untuk mengevaluasi variabel ini guna menjalankan aturan kesalahan secara bersyarat.

Berikut adalah contoh aturan kesalahan yang menguji nilai fault.name:

<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="Source Message Not Available Fault">
    <Step>
        <Name>AM-CustomErrorMessage</Name>
        <Condition>(fault.name Matches "SourceMessageNotAvailable") </Condition>
    </Step>
</FaultRule>

Yang perlu diingat adalah saat kebijakan memicu error, variabel fault.name selalu ditetapkan ke nama error.

Variabel [prefix].[policy_name].failed

Selain fault.name, variabel lain yang biasanya diperiksa developer adalah flag [prefix].[policy_name].failed, yang disetel ke benar atau salah saat kebijakan dijalankan. Dalam aturan kesalahan, Anda harus memeriksa apakah nilainya benar — yaitu, untuk memeriksa apakah terjadi error. Berikut cara membuat kondisional yang memeriksa flag [prefix].[policy_name].failed. Untuk memeriksa variabel ini dengan benar, Anda perlu mengetahui dua hal:

  • Nama kebijakan yang Anda periksa. Ini adalah nilai atribut nama kebijakan, bukan nama tampilan. Atribut ini selalu disertakan dalam XML definisi kebijakan.
  • Awalan yang dikhususkan untuk jenis kebijakan yang Anda periksa. (Kami akan menjelaskan cara menemukan awalan tersebut di bawah.)

Sebagai ilustrasi, berikut contoh aturan kesalahan lainnya. Perhatikan dalam kondisi luar bagaimana nama variabel [prefix].[policy_name].failed terbentuk. Dalam hal ini, awalannya adalah extractvariables dan nama kebijakan adalah ParseJsonResponse. Dalam hal ini, aturan fault hanya akan dijalankan jika variabel ini benar. Berikut tipsnya: karena aturan fault dapat berisi beberapa langkah, pola ini merupakan cara yang bagus untuk mengatur aturan fault ke dalam blok.

<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="Extract Variable Faults">
    <Step>
        <Name>AM-CustomErrorMessage</Name>
        <Condition>(fault.name Matches "SourceMessageNotAvailable") </Condition>
    </Step>
    <Condition>(extractvariables.ParseJsonResponse.failed = true) </Condition>
</FaultRule>

Tentang variabel error dan message

Variabel error hanya tersedia dalam alur error proxy. Anda bisa mendapatkan informasi yang berguna dari variabel error, seperti pesan error, kode status, frasa alasan, dan sebagainya. Pola pemformatan untuk variabel error adalah sebagai berikut:

error.ERROR_COMPONENT = VALUE

Contoh:

error.message = "request message is not available for ExtractVariable:
  ParseJsonResponse"

dan

error.status.code = "500"

Variabel message juga tersedia di alur error dan dapat digunakan untuk tujuan serupa dengan variabel error. Variabel pesan bersifat khusus karena bersifat kontekstual. Dalam alur permintaan, kode ini berperilaku seperti variabel permintaan, dan dalam alur respons, dapat digunakan untuk mendapatkan/menetapkan nilai respons.

Lihat Referensi variabel alur untuk mengetahui informasi tentang semua variabel Apigee, termasuk error dan message.