Kebijakan HTTPModifier

Apa

Kebijakan HTTPModifier dapat mengubah pesan permintaan atau respons yang ada.

Kebijakan ini memungkinkan Anda melakukan tindakan berikut pada pesan tersebut:

• Menambahkan parameter formulir, header, atau parameter kueri baru ke pesan
• Menghapus header, parameter kueri, dan parameter formulir dari pesan
• Menetapkan nilai properti yang ada dalam pesan

Dengan HTTPModifier, Anda dapat menambahkan, mengubah, atau menghapus properti permintaan atau respons. Atau, Anda dapat menggunakan HTTPModifier untuk membuat pesan permintaan atau respons kustom dan meneruskannya ke target alternatif, seperti yang dijelaskan dalam Membuat pesan permintaan kustom.

HTTPModifier menyediakan sebagian fungsi kebijakan AssignMessage. Lihat kebijakan AssignMessage untuk fungsi tambahan, termasuk menetapkan variabel, mengubah payload, dan menyalin nilai dari pesan.

Kebijakan HTTPModifier dapat membuat variabel alur dengan elemen turunan berikut:

• <Add>
• <Set>
• <Remove>
• <AssignTo>

Urutan pengaturan elemen <Add>, <Set>, dan <Remove> penting. Kebijakan akan menjalankan tindakan tersebut sesuai urutan kemunculannya dalam konfigurasi kebijakan. Jika perlu menghapus semua header, lalu menetapkan header tertentu, Anda harus menyertakan elemen <Remove> sebelum elemen <Set>.

Kebijakan ini adalah Kebijakan standar dan dapat di-deploy ke jenis lingkungan apa pun. Untuk mengetahui informasi tentang jenis kebijakan dan ketersediaan dengan setiap jenis lingkungan, lihat Jenis kebijakan.

Kasus penggunaan

Ada banyak situasi yang mungkin membuat Anda ingin mengubah permintaan atau pesan respons selama pemrosesan oleh Apigee. Contoh:

• Tentukan nilai default untuk parameter string kueri atau jenis input lainnya.
• Hapus header HTTP dari pesan permintaan sebelum pesan diteruskan ke layanan backend.
• Tambahkan header HTTP sebelum respons dikirim ke aplikasi konsumen.
• Buat pesan permintaan atau respons yang disesuaikan. Misalnya, Anda dapat menggunakan callout eksternal untuk memanggil API jarak jauh dari proxy API. Anda dapat menggunakan kebijakan HTTPModifier untuk membuat pesan permintaan kustom dan menetapkannya ke variabel. Kemudian, gunakan info eksternal untuk mengirim pesan tersebut ke API jarak jauh.
• Menambahkan header ke permintaan dan respons untuk proses debug dan pemecahan masalah.

Elemen <HTTPModifier>

Menentukan kebijakan HTTPModifier.

Nilai Default	Lihat tab Kebijakan Default, di bawah
Wajib?	Wajib
Jenis	Objek kompleks
Elemen Induk	T/A
Elemen Turunan	<Add> <AssignTo> <DisplayName> <IgnoreUnresolvedVariables> <Remove> <Set>

Elemen <HTTPModifier> menggunakan sintaksis berikut:

Sintaks

Elemen <HTTPModifier> menggunakan sintaksis berikut:

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <!-- All HTTPModifier child elements are optional -->
  <Add>
    <FormParams>
      <FormParam name="FORMPARAM_NAME">FORMPARAM_VALUE</FormParam>
      ...
    </FormParams>
    <Headers>
      <Header name="HEADER_NAME">HEADER_VALUE</Header>
      ...
    </Headers>
    <QueryParams>
      <QueryParam name="QUERYPARAM_NAME">QUERYPARAM_VALUE</QueryParam>
      ...
    </QueryParams>
  </Add>

  <AssignTo createNew="[true|false]" transport="http"
    type="[request|response]">DESTINATION_VARIABLE_NAME</AssignTo>

  <DisplayName>POLICY_DISPLAY_NAME</DisplayName>

  <IgnoreUnresolvedVariables>[true|false]</IgnoreUnresolvedVariables>

  <!-- Can also be empty to remove everything from the message (<Remove/>) -->
  <Remove>
    <!-- Can also be an empty array to remove all FormParams (<FormParams/>) -->
    <FormParams>
      <FormParam name="FORMPARAM_NAME">FORMPARAM_VALUE</FormParam>
      ...
    </FormParams>
    <!-- Can also be an empty array to remove all Headers (<Headers/>) -->
    <Headers>
      <Header name="HEADER_NAME">HEADER_VALUE</Header>
      ...
    </Headers>
    <!-- Can also be an empty array to remove all QueryParams (<QueryParams/>) -->
    <QueryParams>
      <QueryParam name="QUERYPARAM_NAME">QUERYPARAM_VALUE</QueryParam>
      ...
    </QueryParams>
  </Remove>

  <Set>
    <FormParams>
      <FormParam name="FORMPARAM_NAME">FORMPARAM_VALUE</FormParam>
      ...
    </FormParams>
    <Headers>
      <Header name="HEADER_NAME">HEADER_VALUE</Header>
      ...
    </Headers>
    <Path>PATH</Path>
    <QueryParams>
      <QueryParam name="QUERYPARAM_NAME">QUERYPARAM_VALUE</QueryParam>
      ...
    </QueryParams>
    <StatusCode>HTTP_STATUS_CODE or {variable}</StatusCode>
    <Verb>[GET|POST|PUT|PATCH|DELETE|{variable}]</Verb>
    <Version>[1.0|1.1|{variable}]</Verb>
  </Set>

</HTTPModifier>

Kebijakan Default

Contoh berikut menunjukkan setelan default saat Anda menambahkan kebijakan HTTPModifier ke alur di UI Apigee:

<HTTPModifier continueOnError="false" enabled="true" name="http-modifier-default">
  <DisplayName>HTTP Modifier-1</DisplayName>
  <Properties/>
  <Remove>
    <Headers>
      <Header name="h1"/>
    </Headers>
    <QueryParams>
      <QueryParam name="q1"/>
    </QueryParams>
    <FormParams>
      <FormParam name="f1"/>
    </FormParams>
  </Remove>
  <Add>
    <Headers/>
    <QueryParams/>
    <FormParams/>
  </Add>
  <Set>
    <Headers/>
    <QueryParams/>
    <FormParams/>
    <!-- <Verb>GET</Verb> -->
    <Path/>
  </Set>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <AssignTo createNew="false" transport="http" type="request"/>
</HTTPModifier>

Saat Anda menyisipkan kebijakan HTTPModifier baru di UI Apigee, template akan berisi stub untuk semua kemungkinan operasi. Biasanya, Anda memilih operasi yang ingin dilakukan dengan kebijakan ini dan menghapus elemen turunan lainnya. Misalnya, jika Anda ingin melakukan operasi penambahan, gunakan elemen <Add> dan hapus <Remove> serta elemen turunan lainnya dari kebijakan agar lebih mudah dibaca.

Elemen ini memiliki atribut berikut yang umum untuk semua kebijakan:

Atribut	Default	Wajib?	Deskripsi
name	T/A	Wajib	Nama internal kebijakan. Nilai atribut name dapat berisi huruf, angka, spasi, tanda hubung, garis bawah, dan titik. Nilai ini tidak boleh melebihi 255 karakter. Secara opsional, gunakan elemen <DisplayName> untuk memberi label pada kebijakan di editor proxy UI pengelolaan dengan nama bahasa alami yang berbeda.
continueOnError	false	Opsional	Tetapkan ke false untuk menampilkan error saat kebijakan gagal. Perilaku ini wajar terjadi untuk sebagian besar kebijakan. Tetapkan ke true agar eksekusi alur berlanjut meskipun setelah kebijakan gagal. Lihat juga: Aturan error HANYA dipicu dalam status error (tentang continueOnError) Menangani error dalam alur saat ini
enabled	benar	Opsional	Tetapkan ke true untuk menerapkan kebijakan. Tetapkan ke false untuk menonaktifkan kebijakan. Kebijakan tidak akan diterapkan meskipun tetap terlampir ke alur.
async	false	Tidak digunakan lagi	Atribut ini tidak digunakan lagi.

Tabel berikut memberikan deskripsi umum elemen turunan <HTTPModifier>:

Elemen Turunan	Wajib?	Deskripsi
Operasi umum
<Add>	Opsional	Menambahkan informasi ke objek pesan yang ditentukan oleh elemen <AssignTo>. <Add> menambahkan header atau parameter ke pesan yang tidak ada dalam pesan asli. Perhatikan bahwa <Set> juga menyediakan fungsi ini. Untuk menimpa header atau parameter yang ada, gunakan elemen <Set>.
<Remove>	Opsional	Menghapus elemen yang ditentukan dari variabel pesan yang ditentukan dalam elemen <AssignTo>.
<Set>	Opsional	Mengganti nilai properti yang ada pada permintaan atau respons, yang ditentukan oleh elemen <AssignTo>. <Set> menimpa header atau parameter yang sudah ada dalam pesan asli atau menambahkan yang baru jika tidak ada.
Elemen turunan lainnya
<AssignTo>	Opsional	Menentukan pesan yang dioperasikan oleh kebijakan HTTPModifier. Ini dapat berupa permintaan atau respons standar, atau dapat berupa pesan kustom baru.
<IgnoreUnresolvedVariables>	Opsional	Menentukan apakah pemrosesan berhenti saat variabel yang belum terselesaikan ditemukan.

Setiap elemen turunan ini dijelaskan di bagian berikut.

Contoh

Contoh berikut menunjukkan beberapa cara menggunakan kebijakan HTTPModifier:

1: Tambahkan header

Contoh berikut menambahkan header ke permintaan dengan elemen <Add>. Variabel VerifyAPIKey dalam contoh ini dibuat oleh kebijakan VerifyAPIKey:

<HTTPModifier name="HM-add-headers-1">
  <Add>
    <Headers>
      <Header name="partner-id">{verifyapikey.VAK-1.developer.app.partner-id}</Header>
    </Headers>
  </Add>
  <AssignTo>request</AssignTo>
</HTTPModifier>

2: Ubah respons

Contoh berikut mengubah objek respons yang ada dengan menambahkan header ke objek tersebut:

<HTTPModifier name="HM-modify-response">
  <Set>
    <Headers>
      <Header name="Cache-Hit">{lookupcache.LookupCache-1.cachehit}</Header>
    </Headers>
  </Set>
  <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
  <AssignTo>response</AssignTo>
</HTTPModifier>

Contoh ini tidak membuat pesan baru. Sebagai gantinya, metode ini mengubah pesan respons yang ada dengan menambahkan header HTTP.

Karena contoh ini menentukan response sebagai nama variabel dalam elemen <AssignTo>, kebijakan ini akan mengubah objek respons yang awalnya ditetapkan dengan data yang ditampilkan oleh server target.

Header HTTP yang ditambahkan ke pesan respons oleh kebijakan ini berasal dari variabel yang diisi oleh kebijakan LookupCache. Oleh karena itu, pesan respons yang diubah oleh kebijakan HTTPModifier ini berisi header HTTP yang menunjukkan apakah hasilnya telah diambil dari cache atau belum. Menetapkan header dalam respons dapat berguna untuk proses debug dan pemecahan masalah.

Tips: Pola penetapan header untuk proses debug dan pemecahan masalah ini adalah praktik umum. Anda dapat melihat nilai header yang dikirim kembali dengan memeriksa respons dengan alat Debug atau cara lain.

3: Menghapus parameter kueri

Contoh berikut menghapus parameter kueri apikey dari permintaan:

<HTTPModifier name="HM-remove-query-param">
  <Remove>
    <QueryParams>
      <QueryParam name="apikey"/>
    </QueryParams>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

Praktik terbaiknya adalah menghapus parameter kueri apikey dari pesan permintaan saat Anda menggunakan kebijakan VerifyAPIKey untuk autentikasi pengguna. Anda melakukannya untuk mencegah informasi kunci sensitif diteruskan ke target backend.

Referensi elemen turunan

Bagian ini menjelaskan elemen turunan <HTTPModifier>.

<Add>

Menambahkan informasi ke permintaan atau respons, yang ditentukan oleh elemen <AssignTo>.

Elemen <Add> menambahkan properti baru pada pesan yang tidak ada dalam pesan asli. Perhatikan bahwa <Set> juga menyediakan fungsi ini. Untuk mengubah nilai properti yang ada, gunakan elemen <Set>.

Nilai Default	T/A
Wajib?	Opsional
Jenis	Jenis kompleks
Elemen Induk	<HTTPModifier>
Elemen Turunan	<FormParams> <Headers> <QueryParams>

Elemen <Add> menggunakan sintaksis berikut:

Sintaks

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <Add>
    <FormParams>
      <FormParam name="FORMPARAM_NAME">FORMPARAM_VALUE</FormParam>
      ...
    </FormParams>
    <Headers>
      <Header name="HEADER_NAME">HEADER_VALUE</Header>
      ...
    </Headers>
    <QueryParams>
      <QueryParam name="QUERYPARAM_NAME">QUERYPARAM_VALUE</QueryParam>
      ...
    </QueryParams>
  </Add>
</HTTPModifier>

Contoh 1

Contoh berikut menggunakan elemen <FormParams> untuk mendapatkan nilai tiga parameter string kueri dari permintaan awal dan menetapkannya sebagai parameter formulir pada permintaan endpoint target:

<HTTPModifier name="HM-add-formparams-3">
  <Add>
    <FormParams>
      <FormParam name="username">{request.queryparam.name}</FormParam>
      <FormParam name="zip_code">{request.queryparam.zipCode}</FormParam>
      <FormParam name="default_language">{request.queryparam.lang}</FormParam>
    </FormParams>
  </Add>
  <Remove>
    <QueryParams/>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

Contoh 2

Contoh berikut menggunakan elemen <Headers> untuk menambahkan header partner-id ke permintaan yang akan dikirim ke endpoint target:

<HTTPModifier name="HM-add-headers-1">
  <Add>
    <Headers>
      <Header name="partner-id">{verifyapikey.VAK-1.developer.app.partner-id}</Header>
    </Headers>
  </Add>
  <AssignTo>request</AssignTo>
</HTTPModifier>

Contoh 3

Contoh berikut menggunakan elemen <QueryParams> untuk menambahkan satu parameter kueri dengan nilai statis ke permintaan:

<HTTPModifier name="HM-add-queryparams-1">
  <Add>
    <QueryParams>
      <QueryParam name="myParam">42</QueryParam>
    </QueryParams>
  </Add>
  <AssignTo>request</AssignTo>
</HTTPModifier>

Contoh ini menggunakan <Add> dalam pra-alur permintaan. Jika Anda melihat hasilnya di alat seperti Alat debug, permintaan ke https://example-target.com/get menjadi https://example-target.com/get?myParam=42.

Elemen turunan <Add> mendukung penggantian string dinamis, yang dikenal sebagai template pesan.

<FormParams> (turunan dari <Add>)

Menambahkan parameter formulir baru ke pesan permintaan. Elemen ini tidak memengaruhi pesan respons.

Nilai Default	T/A
Wajib?	Opsional
Jenis	Array elemen <FormParam>
Elemen Induk	<Add>
Elemen Turunan	<FormParam>

Elemen <FormParams> menggunakan sintaksis berikut:

Sintaks

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <Add>
    <FormParams>
      <FormParam name="FORMPARAM_NAME">FORMPARAM_VALUE</FormParam>
      ...
    </FormParams>
  <AssignTo createNew="[true|false]" transport="http"
    type="[request|response]">DESTINATION_VARIABLE_NAME</AssignTo>
  </Add>
</HTTPModifier>

Contoh 1

Contoh berikut menambahkan satu parameter formulir (answer) dan nilai statis (42) ke permintaan:

<HTTPModifier name="HM-add-formparams-1">
  <Add>
    <FormParams>
      <FormParam name="answer">42</FormParam>
    </FormParams>
  </Add>
  <AssignTo>request</AssignTo>
</HTTPModifier>

Contoh 2

Contoh berikut mendapatkan nilai parameter kueri name dan menambahkannya ke permintaan sebagai parameter formulir, lalu menghapus parameter kueri:

<HTTPModifier name="HM-Swap-QueryParam-to-FormParams">
  <Add>
    <FormParam name="name">{request.queryparam.name}
  </Add>
  <Remove>
    <QueryParam name="name"/>
  </Remove>
</HTTPModifier>

Perhatikan bahwa contoh ini tidak menentukan target dengan <AssignTo>. Kebijakan ini hanya menambahkan parameter ke permintaan.

Contoh 3

Contoh berikut menambahkan beberapa parameter formulir ke permintaan:

<HTTPModifier name="HM-add-formparams-3">
  <Add>
    <FormParams>
      <FormParam name="username">{request.queryparam.name}</FormParam>
      <FormParam name="zip_code">{request.queryparam.zipCode}</FormParam>
      <FormParam name="default_language">{request.queryparam.lang}</FormParam>
    </FormParams>
  </Add>
  <Remove>
    <QueryParams/>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

Contoh ini mendapatkan parameter string kueri dari permintaan asal dan menambahkannya sebagai parameter formulir dengan nama yang berbeda. Kemudian, parameter kueri asli akan dihapus. Apigee akan mengirimkan permintaan yang diubah ke endpoint target.

Anda dapat menggunakan Alat debug untuk melihat alur. Anda akan melihat bahwa isi permintaan berisi data formulir yang dienkode URL, yang awalnya diteruskan sebagai parameter string kueri:

username=nick&zip_code=90210&default_language=en

Anda hanya dapat menggunakan <FormParams> jika kriteria berikut terpenuhi:

• Kata kerja HTTP: GET, POST
• Jenis pesan: Permintaan
• Salah satu (atau keduanya) dari hal berikut:
  • Data formulir: Tetapkan ke beberapa nilai, atau "" (string kosong). Misalnya, dengan curl, tambahkan -d "" ke permintaan Anda.
  • Header Content-Length: Tetapkan ke 0 (jika tidak ada data dalam permintaan asli; jika tidak, panjang saat ini, dalam byte). Misalnya, dengan curl, tambahkan -H "Content-Length: 0" ke permintaan Anda.

Contoh:

curl -vL -X POST -d "" -H "Content-Type: application/x-www-form-urlencoded"
  https://ahamilton-eval-test.apigee.net/am-test

Saat Anda menambahkan <FormParams>, Apigee menetapkan header Content-Type permintaan ke application/x-www-form-urlencoded sebelum mengirim pesan ke layanan target.

<Headers> (turunan dari <Add>)

Menambahkan header baru ke permintaan atau respons yang ditentukan, yang ditentukan oleh elemen <AssignTo>.

Nilai Default	T/A
Wajib?	Opsional
Jenis	Array elemen <Header>
Elemen Induk	<Add>
Elemen Turunan	<Header>

Elemen <Headers> menggunakan sintaksis berikut:

Sintaks

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <Add>
    <Headers>
      <Header name="HEADER_NAME">HEADER_VALUE</Header>
      ...
    </Headers>
  </Add>
</HTTPModifier>

Contoh 1

Contoh berikut menambahkan header partner-id ke pesan permintaan, dan menetapkan nilai variabel alur verifyapikey.VAK-1.developer.app.partner-id ke header tersebut.

<HTTPModifier name="HM-add-headers-1">
  <Add>
    <Headers>
      <Header name="partner-id">{verifyapikey.VAK-1.developer.app.partner-id}</Header>
    </Headers>
  </Add>
  <AssignTo>request</AssignTo>
</HTTPModifier>

<QueryParams> (turunan dari <Add>)

Menambahkan parameter kueri baru ke permintaan. Elemen ini tidak berpengaruh pada respons.

Nilai Default	T/A
Wajib?	Opsional
Jenis	Array elemen <QueryParam>
Elemen Induk	<Add>
Elemen Turunan	<QueryParam>

Elemen <QueryParams> menggunakan sintaksis berikut:

Sintaks

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <Add>
    <QueryParams>
      <QueryParam name="QUERYPARAM_NAME">QUERYPARAM_VALUE</QueryParam>
      ...
    </QueryParams>
  </Add>
</HTTPModifier>

Contoh 1

Contoh berikut menambahkan parameter kueri myParam ke permintaan dan menetapkan nilai 42 ke parameter tersebut:

<HTTPModifier name="HM-add-queryparams-1">
  <Add>
    <QueryParams>
      <QueryParam name="myParam">42</QueryParam>
    </QueryParams>
  </Add>
  <AssignTo>request</AssignTo>
</HTTPModifier>

Anda hanya dapat menggunakan <QueryParams> jika kriteria berikut terpenuhi:

• Kata kerja HTTP: GET, POST
• Jenis pesan: Permintaan

Selain itu, Anda hanya dapat menetapkan parameter kueri jika atribut type elemen <AssignTo> adalah pesan permintaan. Menetapkan parameter tersebut pada respons tidak akan berpengaruh.

Jika Anda menentukan array parameter kueri kosong dalam kebijakan (<Add><QueryParams/></Add>), kebijakan tidak akan menambahkan parameter kueri apa pun. Ini sama dengan menghapus <QueryParams>.

<AssignTo>

Menentukan objek yang dioperasikan oleh kebijakan HTTPModifier. Opsinya adalah:

• Pesan permintaan: request yang diterima oleh proxy API
• Pesan respons: response yang ditampilkan dari server target
• Pesan kustom: Objek permintaan atau respons kustom

Perhatikan bahwa dalam beberapa kasus, Anda tidak dapat mengubah objek tempat kebijakan HTTPModifier bertindak. Misalnya, Anda tidak dapat menggunakan <Add> atau <Set> untuk menambahkan atau mengubah parameter kueri (<QueryParams>) atau parameter formulir (<FormParams>) pada respons. Anda hanya dapat memanipulasi parameter kueri dan parameter formulir pada permintaan.

Nilai Default	T/A
Wajib?	Opsional
Jenis	String
Elemen Induk	<HTTPModifier>
Elemen Turunan	Tidak ada

Jika Anda tidak menentukan <AssignTo>, atau jika Anda menentukan elemen <AssignTo> tetapi tidak menentukan nilai teks untuk elemen tersebut, kebijakan akan bertindak berdasarkan permintaan atau respons default, yang didasarkan pada tempat kebijakan dieksekusi. Jika kebijakan dijalankan dalam alur permintaan, kebijakan tersebut akan memengaruhi pesan permintaan. Jika dieksekusi dalam alur respons, kebijakan akan memengaruhi respons secara default.

Elemen <AssignTo> menggunakan sintaksis berikut:

Sintaks

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <AssignTo createNew="[true|false]" transport="http"
    type="[request|response]">DESTINATION_VARIABLE_NAME</AssignTo>
</HTTPModifier>

Contoh 1

Contoh berikut tidak menentukan pesan dalam teks <AssignTo>. Hal ini menyiratkan bahwa kebijakan akan bertindak pada pesan request atau response, bergantung pada tempat kebijakan dieksekusi.

<HTTPModifier name="assignto-1">
  <AssignTo createNew="false" transport="http" type="request"/>-- no-op -->
  ...
</HTTPModifier>

Jika Anda menentukan createNew="false", dan tidak memberikan nama pesan secara eksplisit, atribut <AssignTo> lainnya tidak relevan. Dalam hal ini, Anda dapat menghapus elemen <AssignTo> sepenuhnya.

Contoh 2

Contoh berikut membuat objek permintaan baru, yang menimpa objek yang ada:

<HTTPModifier name="assignto-2">
  <AssignTo createNew="true" transport="http" type="request"/>
  ...
</HTTPModifier>

Saat Anda membuat objek permintaan atau respons baru, elemen lain dari kebijakan HTTPModifier (seperti <Add> dan <Set> akan bertindak pada objek permintaan baru tersebut.

Anda dapat mengakses objek permintaan baru di kebijakan lain nanti dalam alur, atau mengirim objek permintaan baru ke layanan eksternal dengan kebijakan ServiceCallout.

Contoh 3

Contoh berikut membuat objek permintaan baru bernama MyRequestObject:

<HTTPModifier name="assignto-3">
  <AssignTo createNew="true" transport="http" type="request">MyRequestObject</AssignTo>
  ...
</HTTPModifier>

Saat Anda membuat objek permintaan atau respons baru, elemen lain dari kebijakan HTTPModifier (seperti <Add> dan <Set> akan bertindak pada objek permintaan baru tersebut.

Anda dapat mengakses objek permintaan baru berdasarkan nama dalam kebijakan lain nanti dalam alur, atau mengirim objek permintaan baru ke layanan eksternal dengan kebijakan ServiceCallout.

Tabel berikut menjelaskan atribut <AssignTo>:

Atribut	Deskripsi	Wajib?	Jenis
createNew	Menentukan apakah kebijakan ini membuat pesan baru saat menetapkan nilai. Jika true, kebijakan akan membuat variabel baru dari jenis yang ditentukan oleh type (request atau response). Jika Anda tidak menentukan nama variabel baru, kebijakan akan membuat permintaan atau objek respons baru, berdasarkan nilai type. Perhatian: Saat membuat objek permintaan atau respons baru, objek permintaan atau respons yang ada akan dihapus dan diganti dengan yang baru, yang berarti semua informasi dalam objek akan hilang. Jika false, kebijakan akan merespons dengan salah satu dari dua cara berikut: Jika <AssignTo> dapat me-resolve nama variabel ke permintaan atau respons, pemrosesan akan dilanjutkan. Misalnya, jika kebijakan berada dalam alur permintaan, variabelnya adalah objek permintaan. Jika kebijakan ada dalam respons, variabelnya adalah objek respons. Jika <AssignTo> tidak dapat diselesaikan, atau diselesaikan ke jenis non-pesan, kebijakan akan menampilkan error. Jika createNew tidak ditentukan, kebijakan akan merespons dengan salah satu dari dua cara berikut: Jika <AssignTo> me-resolve ke pesan, pemrosesan akan dilanjutkan ke langkah berikutnya. Jika <AssignTo> tidak dapat di-resolve, atau di-resolve ke jenis non-pesan, variabel baru dari jenis yang ditentukan di type akan dibuat.	Opsional	Boolean
transport	Menentukan jenis transpor untuk jenis pesan permintaan atau respons. Nilai defaultnya adalah http (satu-satunya nilai yang didukung).	Opsional	String
type	Menentukan jenis pesan baru, jika createNew adalah true. Nilai yang valid adalah request atau response. Nilai defaultnya adalah request. Jika Anda menghilangkan atribut ini, Apigee akan membuat permintaan atau respons, bergantung pada bagian alur tempat kebijakan ini dijalankan.	Opsional	String

<DisplayName>

Gunakan selain atribut name untuk memberi label kebijakan di editor proxy UI pengelolaan dengan nama yang berbeda dan lebih alami.

Elemen <DisplayName> bersifat umum untuk semua kebijakan.

Nilai Default	T/A
Wajib?	Opsional. Jika Anda menghilangkan <DisplayName>, nilai atribut name kebijakan akan digunakan.
Jenis	String
Elemen Induk	<PolicyElement>
Elemen Turunan	Tidak ada

Elemen <DisplayName> menggunakan sintaksis berikut:

Sintaksis

<PolicyElement>
  <DisplayName>POLICY_DISPLAY_NAME</DisplayName>
  ...
</PolicyElement>

Contoh

<PolicyElement>
  <DisplayName>My Validation Policy</DisplayName>
</PolicyElement>

Elemen <DisplayName> tidak memiliki atribut atau elemen turunan.

<IgnoreUnresolvedVariables>

Menentukan apakah pemrosesan berhenti saat variabel yang belum terselesaikan ditemukan.

Nilai Default	Salah
Wajib?	Opsional
Jenis	Boolean
Elemen Induk	<HTTPModifier>
Elemen Turunan	Tidak ada

Tetapkan ke true untuk mengabaikan variabel yang belum terselesaikan dan melanjutkan pemrosesan; jika tidak, false. Nilai defaultnya adalah false.

Menetapkan <IgnoreUnresolvedVariables> ke true berbeda dengan menetapkan continueOnError <HTTPModifier> ke true karena khusus untuk menetapkan dan mendapatkan nilai variabel. Jika Anda menetapkan continueOnError ke true, Apigee akan mengabaikan semua error, bukan hanya error yang terjadi saat menggunakan variabel.

Elemen <IgnoreUnresolvedVariables> menggunakan sintaksis berikut:

Sintaks

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <IgnoreUnresolvedVariables>[true|false]</IgnoreUnresolvedVariables>
</HTTPModifier>

Contoh 1

Contoh berikut menetapkan <IgnoreUnresolvedVariables> ke true:

<HTTPModifier name="HM-Set-Headers">
  <Set>
    <Headers>
      <Header name='new-header'>{possibly-defined-variable}<Header>
    </Headers>
  </Set>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</HTTPModifier>

Karena <IgnoreUnresolvedVariables> disetel ke true, jika variabel possibly-defined-variable tidak ditentukan, kebijakan ini tidak akan menampilkan error.

<Remove>

Menghapus header, parameter kueri, atau parameter formulir dari pesan. Tag kosong akan menghapus semua parameter yang sesuai, termasuk header, formparams, dan queryparams.

Pesan yang terpengaruh dapat berupa permintaan atau respons. Anda menentukan pesan yang akan ditangani oleh <Remove> menggunakan elemen <AssignTo>.

Nilai Default	T/A
Wajib?	Opsional
Jenis	Jenis kompleks
Elemen Induk	<HTTPModifier>
Elemen Turunan	<FormParams> <Headers> <QueryParams>

Kasus penggunaan umum untuk <Remove> adalah menghapus parameter atau header kueri yang berisi informasi sensitif dari objek permintaan yang masuk, untuk menghindari penerusannya ke server backend.

Elemen <Remove> menggunakan sintaksis berikut:

Sintaks

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <!-- Can also be empty to remove everything from the message (<Remove/>) -->
  <Remove>
    <!-- Can also be an empty array to remove all FormParams (<FormParams/>) -->
    <FormParams>
      <FormParam name="FORMPARAM_NAME">FORMPARAM_VALUE</FormParam>
      ...
    </FormParams>
    <!-- Can also be an empty array to remove all Headers (<Headers/>) -->
    <Headers>
      <Header name="HEADER_NAME">HEADER_VALUE</Header>
      ...
    </Headers>
    <!-- Can also be an empty array to remove all QueryParams (<QueryParams/>) -->
    <QueryParams>
      <QueryParam name="QUERYPARAM_NAME">QUERYPARAM_VALUE</QueryParam>
      ...
    </QueryParams>
  </Remove>
</HTTPModifier>

Contoh 1

Contoh berikut menghapus semua parameter formulir dan parameter kueri dari objek request:

<HTTPModifier name="HM-remove-2">
  <Remove>
    <!-- Empty (<FormParams/>) removes all form parameters -->
    <FormParams/>
    <QueryParams>
      <QueryParam name="qp1"/>
    </QueryParams>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

Contoh 2

Contoh berikut menghapus semua hal dari objek pesan:

<HTTPModifier name="HM-remove-3">
  <Remove/>
  <AssignTo>request</AssignTo>
</HTTPModifier>

Biasanya, Anda hanya akan melakukannya jika akan menggunakan elemen <Set> untuk menetapkan beberapa nilai pengganti ke dalam pesan.

<FormParams> (turunan dari <Remove>)

Menghapus parameter formulir yang ditentukan dari permintaan. Elemen ini tidak memengaruhi respons.

Nilai Default	T/A
Wajib?	Opsional
Jenis	Array elemen <FormParam> atau array kosong
Elemen Induk	<Remove>
Elemen Turunan	<FormParam>

Elemen <FormParams> menggunakan sintaksis berikut:

Sintaks

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <!-- Can also be empty to remove everything from the message (<Remove/>) -->
  <Remove>
    <!-- Can also be an empty array to remove all FormParams (<FormParams/>) -->
    <FormParams>
      <FormParam name="FORMPARAM_NAME">FORMPARAM_VALUE</FormParam>
      ...
    </FormParams>
  </Remove>
</HTTPModifier>

Contoh 1

Contoh berikut menghapus tiga parameter formulir dari permintaan:

<HTTPModifier name="HM-remove-formparams-1">
  <Remove>
    <FormParams>
      <FormParam name="form_param_1"/>
      <FormParam name="form_param_2"/>
      <FormParam name="form_param_3"/>
    </FormParams>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

Contoh 2

Contoh berikut menghapus semua parameter formulir dari permintaan:

<HTTPModifier name="HM-remove-formparams-2">
  <Remove>
    <FormParams/>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

Contoh 3

Jika ada beberapa parameter formulir dengan nama yang sama, gunakan sintaksis berikut:

<HTTPModifier name="HM-remove-formparams-3">
  <Remove>
    <FormParams>
      <FormParam name="f1"/>
      <FormParam name="f2"/>
      <FormParam name="f3.2"/>
    </FormParams>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

Contoh ini menghapus f1, f2, dan nilai kedua f3. Jika f3 hanya memiliki satu nilai, nilai tersebut tidak akan dihapus.

Anda hanya dapat menggunakan <FormParams> jika kriteria berikut terpenuhi:

• Jenis pesan: Permintaan
• Content-Type: application/x-www-form-urlencoded

<Headers> (turunan dari <Remove>)

Menghapus header HTTP yang ditentukan dari permintaan atau respons, yang ditentukan oleh elemen <AssignTo>.

Nilai Default	T/A
Wajib?	Opsional
Jenis	Array elemen <Header> atau array kosong
Elemen Induk	<Remove>
Elemen Turunan	<Header>

Elemen <Headers> menggunakan sintaksis berikut:

Sintaks

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <!-- Can also be empty to remove everything from the message (<Remove/>) -->
  <Remove>
    <!-- Can also be an empty array to remove all Headers (<Headers/>) -->
    <Headers>
      <Header name="HEADER_NAME">HEADER_VALUE</Header>
      ...
    </Headers>
  </Remove>
</HTTPModifier>

Contoh 1

Contoh berikut menghapus header user-agent dari permintaan:

<HTTPModifier name="HM-remove-one-header">
  <Remove>
    <Headers>
      <Header name="user-agent"/>
    </Headers>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

Contoh 2

Contoh berikut menghapus semua header dari permintaan:

<HTTPModifier name="HM-remove-all-headers">
  <Remove>
    <Headers/>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

Contoh 3

Jika ada beberapa header dengan nama yang sama, gunakan sintaksis berikut:

<HTTPModifier name="HM-remove-headers-3">
  <Remove>
    <Headers>
      <Header name="h1"/>
      <Header name="h2"/>
      <Header name="h3.2"/>
    </Headers>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

Contoh ini menghapus h1, h2, dan nilai kedua h3 dari permintaan. Jika h3 hanya memiliki satu nilai, nilai tersebut tidak akan dihapus.

<QueryParams> (turunan dari <Remove>)

Menghapus parameter kueri yang ditentukan dari permintaan. Elemen ini tidak memengaruhi respons.

Nilai Default	T/A
Wajib?	Opsional
Jenis	Array elemen <QueryParam> atau array kosong
Elemen Induk	<Remove>
Elemen Turunan	<QueryParam>

Elemen <QueryParams> menggunakan sintaksis berikut:

Sintaks

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <!-- Can also be empty to remove everything from the message (<Remove/>) -->
  <Remove>
    <!-- Can also be an empty array to remove all QueryParams (<QueryParams/>) -->
    <QueryParams>
      <QueryParam name="QUERYPARAM_NAME">QUERYPARAM_VALUE</QueryParam>
      ...
    </QueryParams>
  </Remove>
</HTTPModifier>

Contoh 1

Contoh berikut menghapus satu parameter kueri dari permintaan:

<HTTPModifier name="HM-remove-queryparams-1">
  <Remove>
      <QueryParams>
        <QueryParam name="qp1"/>
      </QueryParams>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

Contoh 2

Contoh berikut menghapus semua parameter kueri dari permintaan:

<HTTPModifier name="HM-remove-queryparams-2">
  &tl;Remove>
      <QueryParams/>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

Contoh 3

Jika ada beberapa parameter kueri dengan nama yang sama, gunakan sintaksis berikut:

<HTTPModifier name="HM-remove-queryparams-3">
  <Remove>
      <QueryParams>
        <QueryParam name="qp1"/>
        <QueryParam name="qp2"/>
        <QueryParam name="qp3.2"/>
      </QueryParams>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

Contoh ini menghapus qp1, qp2, dan nilai kedua qp3 dari permintaan. Jika qp3 hanya memiliki satu nilai, nilai tersebut tidak akan dihapus.

Contoh 4

Contoh berikut menghapus parameter kueri apikey dari permintaan:

<HTTPModifier name="HM-remove-query-param">
  <Remove>
    <QueryParams>
      <QueryParam name="apikey"/>
    </QueryParams>
  </Remove>
  <AssignTo>request</AssignTo>
</HTTPModifier>

Anda hanya dapat menggunakan <QueryParams> jika kriteria berikut terpenuhi:

• Kata kerja HTTP: GET, POST
• Jenis pesan: Permintaan

<Set>

Menetapkan informasi dalam pesan permintaan atau respons, yang ditentukan oleh elemen <AssignTo>. <Set> menimpa header atau parameter kueri atau formulir yang sudah ada dalam pesan asli atau menambahkan yang baru jika tidak ada.

Header serta parameter kueri dan formulir dalam pesan HTTP dapat menyimpan beberapa nilai. Untuk menambahkan nilai tambahan untuk header atau parameter, gunakan elemen <Add>.

Nilai Default	T/A
Wajib?	Opsional
Jenis	Jenis kompleks
Elemen Induk	<HTTPModifier>
Elemen Turunan	<FormParams> <Headers> <Path> <QueryParams> <StatusCode> <Verb> <Version>

Catatan: Sub-elemen <Set> mendukung fitur penggantian string dinamis yang disebut template pesan.

Elemen <Set> menggunakan sintaksis berikut:

Sintaks

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <Set>
    <FormParams>
      <FormParam name="FORMPARAM_NAME">FORMPARAM_VALUE</FormParam>
      ...
    </FormParams>
    <Headers>
      <Header name="HEADER_NAME">HEADER_VALUE</Header>
      ...
    </Headers>
    <Path>PATH</Path>
    <QueryParams>
      <QueryParam name="QUERYPARAM_NAME">QUERYPARAM_VALUE</QueryParam>
      ...
    </QueryParams>
    <StatusCode>HTTP_STATUS_CODE or {variable}</StatusCode>
    <Verb>[GET|POST|PUT|PATCH|DELETE|{variable}]</Verb>
    <Version>[1.0|1.1|{variable}]</Verb>
  </Set>
</HTTPModifier>

Contoh

Contoh berikut menetapkan header tertentu. Jika kebijakan ini dilampirkan dalam alur Permintaan, kebijakan ini akan memungkinkan sistem upstream menerima header tambahan yang tidak disertakan dalam permintaan masuk asli.

<HTTPModifier name="HM-Set-Header">
  <Set>
    <Headers>
        <Header name="authenticated-developer">{verifyapikey.VAK-1.developer.id}</Header>
    </Headers>
  </Set>
  <AssignTo>request</AssignTo>
</HTTPModifier>

<FormParams> (turunan dari <Set>)

Menutupi parameter formulir yang ada pada permintaan dan menggantinya dengan nilai baru yang Anda tentukan dengan elemen ini. Elemen ini tidak berpengaruh pada respons.

Nilai Default	T/A
Wajib?	Opsional
Jenis	Array elemen <FormParam>
Elemen Induk	<Set>
Elemen Turunan	<FormParam>

Elemen <FormParams> menggunakan sintaksis berikut:

Sintaks

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <Set>
    <FormParams>
      <FormParam name="FORMPARAM_NAME">FORMPARAM_VALUE</FormParam>
      ...
    </FormParams>
  </Set>
</HTTPModifier>

Contoh 1

Contoh berikut menetapkan parameter formulir yang disebut myparam ke nilai variabel request.header.myparam dalam permintaan kustom baru:

<HTTPModifier name="HM-set-formparams-1">
  <Set>
    <FormParams>
      <FormParam name="myparam">{request.header.myparam}</FormParam>
    </FormParams>
  </Set>
  <AssignTo createNew="true" transport="http" type="request>>MyCustomRequest</AssignTo>
</HTTPModifier>

Anda hanya dapat menggunakan <FormParams> jika kriteria berikut terpenuhi:

• Verb HTTP: POST
• Jenis pesan: Permintaan

Jika Anda menentukan parameter formulir kosong dalam kebijakan (<Add><FormParams/></Add>), kebijakan tidak akan menambahkan parameter formulir apa pun. Ini sama dengan menghilangkan <FormParams>.

<Set> mengubah Content-Type pesan menjadi application/x-www-form-urlencoded sebelum mengirimnya ke endpoint target.

<Headers> (turunan dari <Set>)

Mengganti header HTTP yang ada dalam permintaan atau respons, yang ditentukan oleh elemen <AssignTo>.

Nilai Default	T/A
Wajib?	Opsional
Jenis	Array elemen <Header>
Elemen Induk	<Set>
Elemen Turunan	<Header>

Elemen <Headers> menggunakan sintaksis berikut:

Sintaks

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <Set>
    <Headers>
      <Header name="HEADER_NAME">HEADER_VALUE</Header>
      ...
    </Headers>
  </Set>
</HTTPModifier>

Contoh 1

Contoh berikut menetapkan header x-ratelimit-remaining ke nilai variabel ratelimit.Quota-1.available.count:

<HTTPModifier name="HM-Set-RateLimit-Header">
  <Set>
    <Headers>
      <Header name="X-RateLimit-Remaining">{ratelimit.Quota-1.available.count}</Header>
    </Headers>
  </Set>
  <AssignTo>response</AssignTo>
</HTTPModifier>

Jika Anda menentukan header kosong dalam kebijakan (<Set><Headers/></Set>), kebijakan tidak akan menetapkan header apa pun. Tindakan ini akan memiliki efek yang sama seperti menghapus <Headers>.

<Path> (turunan dari <Set>)

Catatan:

Elemen ini saat ini tidak berfungsi seperti yang dirancang untuk mengganti/menulis ulang URL target proxy.

Terkadang Anda mungkin perlu mengirim pesan ke URL selain URL yang ditentukan dalam TargetEndpoint proxy API. (Anda tidak dapat mengganti target.url di ProxyEndpoint, karena Apigee menetapkan variabel di TargetEndpoint).

<QueryParams> (turunan dari <Set>)

Mengganti parameter kueri yang ada dalam permintaan dengan nilai baru. Elemen ini tidak memengaruhi respons.

Nilai Default	T/A
Wajib?	Opsional
Jenis	Array elemen <QueryParam>
Elemen Induk	<Set>
Elemen Turunan	<QueryParam>

Elemen <QueryParams> menggunakan sintaksis berikut:

Sintaks

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <Set>
    <QueryParams>
      <QueryParam name="QUERYPARAM_NAME">QUERYPARAM_VALUE</QueryParam>
      ...
    </QueryParams>
  </Set>
</HTTPModifier>

Contoh 1

Contoh berikut menetapkan parameter kueri address ke nilai variabel request.header.address:

<HTTPModifier name="HM-set-queryparams-1">
  <Set>
    <QueryParams>
      <QueryParam name="address">{request.header.address}</QueryParam>
    </QueryParams>
  </Set>
</HTTPModifier>

Anda hanya dapat menggunakan <QueryParams> jika kriteria berikut terpenuhi:

• Kata kerja HTTP: GET, POST
• Jenis pesan: Permintaan

Jika Anda menentukan parameter kueri kosong dalam kebijakan (<Set><QueryParams/></Set>), kebijakan tidak akan menetapkan parameter kueri apa pun. Ini sama dengan menghapus <QueryParams>.

<StatusCode> (turunan dari <Set>)

Menetapkan kode status pada respons. Elemen ini tidak berpengaruh pada permintaan.

Nilai Default	'200' (jika atribut createNew <AssignTo> ditetapkan ke 'true')
Wajib?	Opsional
Jenis	String atau VARIABLE
Elemen Induk	<Set>
Elemen Turunan	Tidak ada

Elemen <StatusCode> menggunakan sintaksis berikut:

Sintaks

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <Set>
    <StatusCode>HTTP_STATUS_CODE or {variable}</StatusCode>
  </Set>
</HTTPModifier>

Contoh 1

Contoh berikut menetapkan kode status sederhana:

<HTTPModifier name="HM-set-statuscode-404">
  <Set>
    <StatusCode>404<<StatusCode>
  </Set>
  <AssignTo>response</AssignTo>
</HTTPModifier>

Contoh 2

Konten <StatusCode> diperlakukan sebagai template pesan. Ini berarti nama variabel yang diapit dalam tanda kurung kurawal akan diganti saat runtime dengan nilai variabel yang dirujuk, seperti yang ditunjukkan pada contoh berikut:

<HTTPModifier name="set-statuscode-2">
  <Set>
    <StatusCode>{calloutresponse.status.code}</StatusCode>
  </Set>
  <AssignTo>response</AssignTo>
</HTTPModifier>

Anda hanya dapat menggunakan <StatusCode> jika kriteria berikut terpenuhi:

• Jenis pesan: Respons

<Verb> (turunan dari <Set>)

Menetapkan kata kerja HTTP pada permintaan. Elemen ini tidak berpengaruh pada respons.

Nilai Default	T/A
Wajib?	Opsional
Jenis	String atau VARIABLE
Elemen Induk	<Set>
Elemen Turunan	Tidak ada

Elemen <Verb> menggunakan sintaksis berikut:

Sintaks

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <Set>
    <Verb>[GET|POST|PUT|PATCH|DELETE|{variable}]</Verb>
  </Set>
</HTTPModifier>

Contoh 1

Contoh berikut menetapkan kata kerja sederhana pada permintaan:

<HTTPModifier name="HM-set-verb-1">
  <Set>
    <Verb>POST</Verb>
  </Set>
  <AssignTo>request</AssignTo>
</HTTPModifier>

Contoh 2

Konten <Verb> diperlakukan sebagai template pesan. Artinya, nama variabel yang digabungkan dalam tanda kurung kurawal akan diganti saat runtime dengan nilai variabel yang dirujuk.

Contoh berikut menggunakan variabel untuk mengisi kata kerja:

<HTTPModifier name="HM-set-verb-to-dynamic-value">
  <Set>
    <Verb>{my_variable}</Verb>
  </Set>
  <AssignTo>request</AssignTo>
</HTTPModifier>

Anda hanya dapat menggunakan <Verb> jika kriteria berikut terpenuhi:

• Jenis pesan: Permintaan

<Version> (turunan dari <Set>)

Menetapkan versi HTTP pada permintaan. Elemen ini tidak berpengaruh pada respons.

Nilai Default	T/A
Wajib?	Opsional
Jenis	String atau VARIABLE
Elemen Induk	<Set>
Elemen Turunan	Tidak ada

Elemen <Version> menggunakan sintaksis berikut:

Sintaks

<HTTPModifier
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="POLICY_NAME" >
  <Set>
    <Version>[1.0|1.1|{variable}]</Verb>
  </Set>
</HTTPModifier>

Contoh 1

Contoh berikut menetapkan nomor versi ke 1.1:

<HTTPModifier name="HM-set-version-1">
  <Set>
    <Version>1.1</Version>
  </Set>
</HTTPModifier>

Contoh 2

Berikut ini menggunakan variabel dalam tanda kurung kurawal untuk menetapkan nomor versi:

<HTTPModifier name="HM-set-version-2">
  <Set>
    <Version>{my_version}</Version>
  </Set>
  <AssignTo>request</AssignTo>
</HTTPModifier>

Konten <Version> diperlakukan sebagai template pesan. Artinya, nama variabel yang diapit dalam tanda kurung kurawal akan diganti saat runtime dengan nilai variabel yang dirujuk.

Anda hanya dapat menggunakan <Version> jika kriteria berikut terpenuhi:

• Jenis pesan: Permintaan

Membuat pesan permintaan kustom

Anda dapat menggunakan HTTPModifier untuk membuat pesan permintaan kustom. Setelah membuat permintaan kustom, Anda dapat menggunakannya dengan cara berikut:

• Mengakses variabelnya di kebijakan lain
• Meneruskannya ke layanan eksternal

Catatan: Anda tidak dapat meneruskan pesan permintaan kustom ke endpoint target dalam alur. Apigee hanya meneruskan permintaan asli (dengan modifikasi apa pun yang mungkin Anda buat) ke endpoint target.

Untuk membuat pesan permintaan kustom, gunakan elemen <AssignTo> dalam kebijakan HTTPModifier Anda. Tetapkan createNew ke true dan tentukan nama pesan baru dalam isi elemen, seperti yang ditunjukkan pada contoh berikut:

<HTTPModifier name="assignto-3">
    <AssignTo createNew="true" transport="http" type="request">MyRequestObject</AssignTo>
    ...
  </HTTPModifier>

Secara default, Apigee tidak melakukan apa pun dengan pesan permintaan kustom. Setelah membuatnya, Apigee akan melanjutkan alur dengan permintaan asli. Untuk menggunakan permintaan kustom, tambahkan kebijakan yang menggunakan pesan permintaan dan secara eksplisit mereferensikan pesan permintaan yang baru dibuat dalam konfigurasi untuk kebijakan tersebut. Hal ini akan memungkinkan Anda meneruskan permintaan kustom ke endpoint layanan eksternal.

Contoh berikut membuat pesan permintaan kustom:

Contoh 1

Contoh berikut membuat objek permintaan kustom dengan HTTPModifier:

<HTTPModifier name="HTTPModifier-3">
  <AssignTo createNew="true" type="request">MyCustomRequest</AssignTo>
  <Set>
    <QueryParams>
      <QueryParam name="address">{request.queryparam.addy}</QueryParam>
    </QueryParams>
    <Verb>GET</Verb>
  </Set>
  <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
</HTTPModifier>

Contoh ini:

• Membuat objek pesan permintaan baru yang disebut MyCustomRequest.
• Di MyCustomRequest, kebijakan ini:
  • Menetapkan parameter kueri address pada pesan kustom ke nilai parameter kueri addy permintaan masuk.
  • Menetapkan kata kerja HTTP ke GET.
• Menetapkan <IgnoreUnresolvedVariables> ke false. Jika <IgnoreUnresolvedVariables> adalah false, jika salah satu variabel yang dirujuk dalam konfigurasi kebijakan tidak ada, Apigee akan memasuki status error dalam alur API.

Contoh 2

Berikut adalah contoh lain yang menunjukkan cara membuat objek permintaan kustom dengan HTTPModifier:

<HTTPModifier name="HTTPModifier-2">
  <AssignTo createNew="true" type="request">partner.request</AssignTo>
  <Set>
    <Verb>POST</Verb>
  </Set>
</HTTPModifier>

Contoh ini membuat permintaan kustom baru yang disebut partner.request. Kemudian, metode ini menetapkan <Verb> pada permintaan baru.

Anda dapat mengakses berbagai properti pesan kustom dalam kebijakan HTTPModifier lain yang terjadi nanti dalam alur. Contoh berikut mendapatkan nilai header dari respons kustom bernama, dan menempatkannya ke header baru dalam pesan permintaan:

<HTTPModifier name="HM-Set-Header">
  <AssignTo>request</AssignTo>
  <Set>
    <Headers>
      <Header name="injected-approval-id">{MyCalloutResponse.header.approval-id}</Header>
    </Headers>
  </Set>
</HTTPModifier>

Kode error

Bagian ini menjelaskan kode kesalahan dan pesan error yang ditampilkan dan variabel kesalahan yang disetel oleh Apigee saat kebijakan ini memicu error. Informasi ini penting untuk diketahui apakah Anda mengembangkan aturan kesalahan untuk menangani kesalahan. Untuk mempelajari lebih lanjut, lihat Yang perlu Anda ketahui tentang error kebijakan dan Menangani kesalahan.

Error runtime

Error ini dapat terjadi saat kebijakan dieksekusi.

Tips: Perlu bantuan untuk mengatasi error? Klik di kolom Fix untuk mengetahui informasi pemecahan masalah selengkapnya.

Kode kesalahan	Status HTTP	Penyebab	Perbaikan
entities.UnresolvedVariable	500	Variabel Template Pesan dalam Tidak ditentukan atau di luar cakupan.
steps.httpmodifier.InvalidStatusCode	500	Nilai kode status yang diselesaikan tidak valid. Lihat string fault untuk mengetahui informasi selengkapnya.

Error saat deployment

Error ini dapat terjadi saat Anda men-deploy proxy yang berisi kebijakan ini.

Tips: Perlu bantuan untuk mengatasi error? Klik di samping deskripsi penyebab error untuk membuka halaman pemecahan masalah.

Nama error	Penyebab	Perbaikan
InvalidIndex	Jika indeks yang ditentukan dalam elemen <Remove> kebijakan HTTPModifier adalah 0 atau angka negatif, deployment Proxy API akan gagal.

Variabel kesalahan

Variabel ini ditetapkan saat kebijakan ini memicu error saat runtime. Untuk informasi selengkapnya, lihat Yang perlu Anda ketahui tentang error kebijakan.

Variabel	Dari mana	Contoh
httpmodifier.POLICY_NAME.failed	POLICY_NAME adalah nama kebijakan yang ditentukan pengguna yang menampilkan kesalahan.	httpmodifier.HM-SetResponse.failed = true

Contoh respons error

Catatan: Untuk penanganan error, praktik terbaiknya adalah menjebak bagian errorcode dari respons error. Jangan mengandalkan teks di faultstring, karena bisa berubah.

{
   "fault":{
      "detail":{
         "errorcode":"steps.httpmodifier.InvalidStatusCode"
      },
      "faultstring":"HTTPModifier[HM-SetResponse]: Invalid status code bad_request"
   }
}

Contoh aturan kesalahan

<FaultRule name="HTTPModifier Faults">
    <Step>
        <Name>HM-CustomNonMessageTypeErrorResponse</Name>
        <Condition>(fault.name Matches "InvalidStatusCode")</Condition>
    </Step>
    <Condition>(httpmodifier.failed = true)</Condition>
</FaultRule>

Skema

Setiap jenis kebijakan ditentukan oleh skema XML (.xsd). Sebagai referensi, skema kebijakan tersedia di GitHub.