Mengembalikan respons

BERLAKU UNTUK: Semua tingkatAN API Management

Kebijakan return-response membatalkan eksekusi alur dan mengembalikan respons default atau kustom kepada pemanggil. Respons default adalah 200 OK tanpa isi. Respons khusus dapat ditentukan melalui variabel konteks atau pernyataan kebijakan. Jika keduanya disediakan, respons yang terdapat dalam variabel konteks diubah oleh pernyataan kebijakan sebelum dikembalikan ke pemanggil.

Catatan

Tetapkan elemen kebijakan dan elemen turunan dalam urutan yang disediakan dalam pernyataan kebijakan. Pelajari lebih lanjut cara mengatur atau mengedit kebijakan API Management.

Pernyataan kebijakan

<return-response response-variable-name="existing context variable">
  <set-status>...</set-status>
  <set-header>...</set-header>
  <set-body>...</set-body>
</return-response>

Atribut

Atribut	Deskripsi	Wajib diisi	Bawaan
respons-variabel-nama	Nama variabel konteks yang dirujuk dari, misalnya, kebijakan kirim-permintaan upstram dan berisi Response objek. Ekspresi kebijakan tidak diizinkan.	Tidak.	T/A

Elemen

Elemen	Deskripsi	Wajib diisi
atur-status	Mengatur kode status respons.	Tidak.
atur-judul	Mengatur header dalam respons.	Tidak.
set-body	Mengatur isi dalam respons.	Tidak.

Penggunaan

• Bagian kebijakan: masuk, keluar, backend, saat terjadi kesalahan
• Cakupan kebijakan: global, ruang kerja, produk, API, operasi
• Gateway: klasik, v2, konsumsi, dihost sendiri, ruang kerja

Catatan penggunaan

• Templat cairan tidak berfungsi saat ditentukan di dalam isi (diatur menggunakan set-body) return-response kebijakan. Kebijakan return-response membatalkan alur eksekusi saat ini dan menghapus isi permintaan dan isi respons dalam konteks saat ini. Akibatnya, templat cair yang ditentukan di dalam kebijakan menerima string kosong sebagai inputnya dan tidak akan menghasilkan output yang diharapkan.

Contoh

<return-response>
   <set-status code="401" reason="Unauthorized"/>
   <set-header name="WWW-Authenticate" exists-action="override">
      <value>Bearer error="invalid_token"</value>
   </set-header>
</return-response>

Kebijakan terkait

• Transformasi

Konten terkait

Untuk informasi selengkapnya tentang bekerja dengan kebijakan, lihat:

• Tutorial: Mengubah dan melindungi API Anda
• Referensi Kebijakan untuk daftar lengkap pernyataan kebijakan dan pengaturannya
• Ekspresi kebijakan
• Mengatur atau mengedit kebijakan
• Menggunakan kembali konfigurasi kebijakan
• Repositori cuplikan kebijakan
• Repositori taman bermain kebijakan
• Toolkit kebijakan Azure API Management
• Mendapatkan bantuan Copilot untuk membuat, menjelaskan, dan memecahkan masalah kebijakan