Kebijakan ReadPropertySet

Kebijakan ReadPropertySet membaca set properti dan mengisi variabel alur dengan hasilnya.

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

Elemen <ReadPropertySet>

Menentukan kebijakan ReadPropertySet.

Nilai Default	Lihat tab Kebijakan Default di bawah
Wajib?	Wajib
Jenis	Objek kompleks
Elemen Induk	T/A
Elemen Turunan	<Read>

Elemen <ReadPropertySet> menggunakan sintaksis berikut:

Sintaksis

Elemen <ReadPropertySet> menggunakan sintaksis berikut:

<ReadPropertySet name="read-property-set">
  <Read>
    <Name ref="set-ref">property-set-name</Name>
    <Key ref="key-ref">key-name</Key>
    <AssignTo>var1</AssignTo>
    <DefaultValue>default-value</DefaultValue>
  </Read>
  ...
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</ReadPropertySet>

Kebijakan Default

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

<ReadPropertySet name="read-property-set">
  <Read>
    <Name ref="set-ref">property-set-name</Name>
    <Key ref="key-ref">key-name</Key>
    <AssignTo>var1</AssignTo>
    <DefaultValue>default-value</DefaultValue>
  </Read>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</ReadPropertySet>

Saat Anda menyisipkan kebijakan ReadPropertySet baru di UI Apigee, template berisi stub untuk semua kemungkinan operasi. Lihat di bawah untuk mengetahui informasi tentang elemen yang diperlukan.

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 tentang elemen turunan <ReadPropertySet>:

Elemen Turunan	Wajib?	Deskripsi
<Read>	Wajib	Membaca dan menyelesaikan variabel set properti serta menyetelnya ke variabel alur yang ditentukan.
<IgnoreUnresolvedVariables>	Opsional	Menentukan apakah pemrosesan berhenti saat set properti tidak terselesaikan.

Contoh

Bagian ini memberikan contoh penggunaan <ReadPropertySet>.

Contoh

Contoh ini menggunakan <ReadPropertySet> untuk mendapatkan propertyset.environment.name.request.headers.api-version dan menetapkannya ke target_url. Jika nilai set properti tidak diperoleh, https://httpbin.org/get akan digunakan.

<ReadPropertySet name="read-property-set">
  <Read>
    <Name ref="set-ref">environment.name</Name>
    <Key ref="key-ref">request.headers.api-version</Key>
    <AssignTo>target_url</AssignTo>
    <DefaultValue>https://httpbin.org/get</DefaultValue>
  </Read>
  <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
</ReadPropertySet>

Referensi elemen turunan

Bagian ini menjelaskan elemen turunan <ReadPropertySet>.

<Read>

Menyelesaikan variabel set properti dan menetapkan hasilnya dalam variabel alur.

Elemen <Read> menentukan variabel set properti yang akan di-resolve dan variabel alur yang akan ditetapkan nilainya. Ini juga mencakup nilai default opsional, yang digunakan jika set properti tidak dapat diselesaikan. Anda dapat menyertakan beberapa elemen <Read> dalam satu kebijakan <ReadPropertySet>.

Nilai Default	T/A
Wajib?	Opsional
Jenis	Jenis kompleks
Elemen Induk	<ReadPropertySet>
Elemen Turunan	<Name> <Key> <AssignTo> <DefaultValue>

Elemen <Read> menggunakan sintaksis berikut:

Sintaksis

<Read>
  <Name ref="set-ref">property-set-name</Name>
  <Key ref="key-ref">key-name</Key>
  <AssignTo>var1</AssignTo>
  <DefaultValue>default-value</DefaultValue>
</Read>

Contoh

Contoh ini menggunakan <ReadPropertySet> untuk mendapatkan propertyset.environment.name.request.headers.api-version dan menetapkannya ke target_url. Jika nilai set properti tidak diperoleh, https://httpbin.org/get akan digunakan.

<ReadPropertySet name="read-property-set">
  <Read>
    <Name ref="environment.name">my-property-set-name</Name>
    <Key ref="request.headers.api-version">my-property-set-key</Key>
    <AssignTo>target_url</AssignTo>
    <DefaultValue>https://httpbin.org/get</DefaultValue>
  </Read>
  <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
</ReadPropertySet>

Tabel berikut memberikan deskripsi umum elemen turunan <Read>.

Elemen Turunan	Wajib?	Deskripsi
<Name>	Wajib	String Properti yang ditetapkan untuk dibaca. Berikan ref, nilai, atau keduanya. Apigee pertama-tama mencoba menyelesaikan Name berdasarkan ref, lalu nilai. Jika keduanya tidak dapat diselesaikan, <DefaultValue>, jika diberikan, akan berlaku. <Name> dan <Key> digabungkan menjadi propertyset.{value_resolved_from_Name}.{value_resolved_from_Key}.
<Key>	Wajib	String Kunci set properti yang digunakan saat menyelesaikan variabel. Berikan ref, nilai, atau keduanya. Apigee pertama-tama mencoba menyelesaikan Key berdasarkan ref, lalu nilai. Jika keduanya tidak dapat diselesaikan, <DefaultValue>, jika diberikan, akan berlaku. <Name> dan <Key> digabungkan menjadi propertyset.{value_resolved_from_Name}.{value_resolved_from_Key}.
<AssignTo>	Wajib	String Menentukan variabel alur untuk menetapkan variabel yang di-resolve.
<DefaultValue>	Opsional	String Menentukan nilai default yang akan digunakan saat variabel tidak dapat diselesaikan.

<IgnoreUnresolvedVariables>

Menentukan apakah pemrosesan berhenti saat set properti tidak terselesaikan. Disetel ke true untuk mengabaikan variabel yang belum terselesaikan dan melanjutkan pemrosesan.

IgnoreUnresolvedVariables tidak berlaku jika <DefaultValue> diberikan.

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

Referensi error

Bagian ini menjelaskan kode kesalahan dan pesan error yang ditampilkan serta variabel kesalahan yang ditetapkan oleh Apigee khusus untuk kebijakan <ReadPropertySet>. Informasi ini penting untuk diketahui jika 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 dijalankan.

Kode kesalahan	Status HTTP	Penyebab
steps.readpropertyset.UnresolvedVariable	500	Error ini terjadi jika variabel yang ditentukan dalam kebijakan ReadPropertySet adalah: Di luar cakupan (tidak tersedia dalam alur tertentu tempat kebijakan dijalankan) atau Tidak dapat diselesaikan (tidak ditentukan). Jika <IgnoreUnresolvedVariables> salah dan <DefaultValue> tidak ditentukan, resolusi akan gagal.

Error saat deployment

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

Nama error	Penyebab
steps.readpropertyset.EmptyReads	Kebijakan tidak memiliki elemen turunan <Read>.
steps.readpropertyset.FieldUnset	Kode ini ditampilkan jika salah satu hal berikut benar: Referensi maupun nama tidak ditetapkan untuk <Name> Referensi maupun nama tidak ditetapkan untuk <Key> Tidak ada nilai yang diberikan untuk <AssignTo>

Variabel kesalahan

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

Variabel	Di mana	Contoh
fault.name="FAULT_NAME"	FAULT_NAME adalah nama kesalahan, seperti yang tercantum dalam tabel Error runtime di atas. Nama kesalahan adalah bagian terakhir dari kode kesalahan.	fault.name Matches "UnresolvedVariable"
readpropertyset.POLICY_NAME.failed	POLICY_NAME adalah nama kebijakan yang ditentukan pengguna yang menyebabkan kesalahan.	readpropertyset.RPS-SetResponse.failed = true

Contoh respons error

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

  {
    "fault": {
      "faultstring": "ReadPropertySet[RPS-SetResponse]: unable to resolve variable [variable_name]",
      "detail": {
        "errorcode": "steps.readpropertyset.UnresolvedVariable"
      }
    }
  }
  

Contoh aturan kesalahan

  <FaultRule name="ReadPropertySet Faults">
      <Step>
          <Name>RPS-CustomSetVariableErrorResponse</Name>
          <Condition>(fault.name = "SetVariableFailed")</Condition>
      </Step>
      <Condition>(readpropertyset.failed = true)</Condition>
  </FaultRule>
  

Skema

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