kebijakan PublishMessage

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Baca dokumentasi Apigee Edge.

ikon kebijakan

Ringkasan

Kebijakan PublishMessage memungkinkan Anda memublikasikan informasi aliran proxy API ke topik Google Cloud Pub/Sub. Pub/Sub Google memungkinkan layanan berkomunikasi secara asinkron, dengan latensi yang jauh lebih sedikit. Untuk mengetahui informasi selengkapnya tentang Pub/Sub, lihat Apa yang dimaksud dengan Pub/Sub?. Informasi yang ingin Anda publikasikan ke topik Pub/Sub dapat berupa teks literal atau variabel alur. Anda juga dapat menentukan kombinasi teks literal dan variabel alur menggunakan template pesan.

Jika permintaan publikasi berhasil, Apigee akan menetapkan variabel alur publishmessage.message.id ke nilai yang ditampilkan oleh server Pub/Sub. Untuk informasi selengkapnya, lihat Variabel alur.

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

Autentikasi dan deployment proxy

Untuk menjalankan kebijakan PublishMessage, Anda memerlukan token autentikasi. Namun, tidak ada elemen <Authentication> eksplisit dalam definisi kebijakan. Anda harus men-deploy proxy API untuk menggunakan autentikasi Google, yang menambahkan token autentikasi ke permintaan di balik layar. Untuk mengetahui informasi tentang cara men-deploy proxy API yang menggunakan autentikasi Google, lihat Langkah-langkah deployment. Selain menggunakan autentikasi Google di proxy API, Anda harus men-deploy proxy API dengan akun layanan yang memiliki peran dengan izin pubsub.topics.publish. Untuk mengetahui informasi selengkapnya tentang peran Identity and Access Management (IAM) untuk Pub/Sub, lihat Izin dan peran.

<PublishMessage>

Menentukan kebijakan PublishMessage.

Nilai Default T/A
Wajib? Diperlukan
Type Jenis kompleks
Elemen Induk T/A
Elemen Turunan <CloudPubSub>
<DisplayName>
<Source>

Tabel berikut memberikan deskripsi tingkat tinggi dari elemen turunan <PublishMessage>:

Elemen Turunan Wajib? Deskripsi
<CloudPubSub> Diperlukan Elemen induk <Topic>. Elemen <Topic> menentukan topik Pub/Sub tempat Anda ingin memublikasikan pesan.
<DisplayName> Opsional Nama kustom untuk kebijakan.
<IgnoreUnresolvedVariables> Opsional Menentukan apakah pemrosesan akan berhenti jika Apigee menemukan variabel yang belum terselesaikan.
<Source> Diperlukan Menentukan pesan yang akan dipublikasikan.
Elemen turunan lainnya
<Topic> Diperlukan Menentukan topik Pub/Sub tempat Anda ingin memublikasikan pesan.

Elemen <PublishMessage> menggunakan sintaksis berikut:

Sintaksis

<?xml version="1.0" encoding="UTF-8"?><PublishMessage continueOnError="[true|false]" enabled="[true|false]" name="Publish-Message-1">
    <DisplayName>DISPLAY_NAME</DisplayName>
    <Source>SOURCE_VALUE</Source>
    <CloudPubSub>
        <Topic>TOPIC_NAME</Topic>
    </CloudPubSub>
    <IgnoreUnresolvedVariables>[true|false]</IgnoreUnresolvedVariables>
</PublishMessage>

Contoh

Contoh berikut menunjukkan definisi kebijakan <PublishMessage>:

<?xml version="1.0" encoding="UTF-8"?><PublishMessage continueOnError="false" enabled="true" name="Publish-Message-1">
    <DisplayName>Publish Message-1</DisplayName>
    <Source>{flow-variable-1}</Source>
    <CloudPubSub>
        <Topic>projects/{flow-variable-project-id}/topics/{flow-variable-topic-name}</Topic>
    </CloudPubSub>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</PublishMessage>

Elemen ini memiliki atribut berikut yang sama 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.

Atau, gunakan elemen <DisplayName> untuk memberi label kebijakan di editor proxy UI pengelolaan dengan nama natural-language yang berbeda.
continueOnError false Opsional Setel ke false untuk menampilkan error jika kebijakan gagal. Ini adalah perilaku yang wajar untuk sebagian besar kebijakan. Setel ke true agar eksekusi alur tetap berlanjut bahkan setelah kebijakan gagal. Lihat juga:
enabled true Opsional Setel ke true untuk menerapkan kebijakan. Setel ke false untuk menonaktifkan kebijakan. Kebijakan tidak akan diterapkan meskipun tetap melekat pada alur.
async   false Tidak digunakan lagi Atribut ini sudah tidak digunakan lagi.

Referensi elemen turunan

Bagian ini menjelaskan elemen turunan <PublishMessage>.

<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.

<Source>

Menentukan pesan yang akan dipublikasikan.

Pesan dapat berupa teks literal, variabel alur, atau kombinasi keduanya dalam bentuk template pesan.

Nilai Default T/A
Wajib? Diperlukan
Type String
Elemen Induk <PublishMessage>
Elemen Turunan Tidak ada

Elemen <Source> menggunakan sintaksis berikut:

Sintaksis

 <Source>SOURCE</Source>

Example-1

Contoh berikut menetapkan pesan sumber ke nilai variabel alur flow-var-1:

<Source>{flow-var-1}</Source>

Example-2

Contoh berikut menetapkan pesan sumber ke source-message-text-01:

<Source>source-message-text-01</Source>

<CloudPubSub>

Elemen induk <Topic>.

Anda hanya dapat memublikasikan ke satu topik Pub/Sub. Oleh karena itu, Anda hanya dapat memiliki satu elemen <Topic> di elemen <CloudPubSub>.

Nilai Default T/A
Wajib? Diperlukan
Type Jenis kompleks
Elemen Induk <PublishMessage>
Elemen Turunan <Topic>

Elemen <CloudPubSub> menggunakan sintaksis berikut:

Sintaksis

<CloudPubSub>
  <Topic>TOPIC_NAME</Topic>
</CloudPubSub>

Contoh

Contoh berikut menunjukkan deklarasi elemen <CloudPubSub>:

<CloudPubSub>
  <Topic>projects/{request.header.project}/topics/{request.header.topic}</Topic>
</CloudPubSub>

<Topic>

Menentukan topik Pub/Sub tempat Anda ingin memublikasikan pesan <Source>.

Anda harus menentukan nama topik dalam format projects/project-id/topics/topic-name.

Nilai Default T/A
Wajib? Diperlukan
Type Jenis kompleks
Elemen Induk <CloudPubSub>
Elemen Turunan Tidak ada

Elemen <Topic> menggunakan sintaksis berikut:

Sintaksis
<Topic>TOPIC_NAME</Topic>
Contoh

Contoh berikut menentukan topik Pub/Sub yang menjadi tujuan publikasi:

<Topic>projects/project-id-marketing/topics/topic-name-test1</Topic>

Dalam contoh ini, project-id-marketing adalah Project ID Google Cloud Anda dan topic-name-test1 adalah topik tempat pesan <Source> harus dipublikasikan.

<IgnoreUnresolvedVariables>

Menentukan apakah pemrosesan akan berhenti jika Apigee menemukan variabel yang belum terselesaikan.

Nilai Default Salah
Wajib? Opsional
Type Boolean
Elemen Induk <PublishMessage>
Elemen Turunan Tidak ada

Tetapkan nilai 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 <PublishMessage> ke true. Jika Anda menetapkan continueOnError ke true, Apigee akan mengabaikan semua error, bukan hanya error dalam variabel.

Elemen <IgnoreUnresolvedVariables> menggunakan sintaksis berikut:

Sintaksis

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

Contoh

Contoh berikut menetapkan <IgnoreUnresolvedVariables> ke true:

<IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>

Variabel alur

Variabel alur adalah objek yang menyimpan data tertentu dan tersedia untuk Anda dalam konteks alur proxy API. Variabel ini menyimpan informasi seperti informasi payload, jalur URL, alamat IP, dan data dari eksekusi kebijakan. Untuk informasi selengkapnya tentang variabel alur, lihat Menggunakan variabel alur.

Jika kebijakan PublishMessage berhasil dipublikasikan ke topik Pub/Sub, Apigee akan menetapkan variabel alur publishmessage.message.id ke messageId yang ditampilkan oleh server Pub/Sub. Variabel alur adalah string jenis, dan variabel tersedia untuk Anda mulai dari alur permintaan Proxy dan seterusnya. Berdasarkan kebutuhan, Anda dapat menggunakan variabel flow di kebijakan downstream lainnya. Namun, jika publikasi gagal, Apigee tidak menetapkan variabel publishmessage.message.id, dan mengakses variabel ini akan menyebabkan error.

Untuk informasi selengkapnya tentang berbagai jenis variabel alur, lihat Referensi variabel flow.

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.

Kode kesalahan Status HTTP Penyebab
steps.publishmessage.PermissionDeniedError 500 Error ini terjadi ketika akun layanan runtime tidak dapat meniru identitas akun layanan proxy atau akun layanan proxy tidak memiliki izin untuk memublikasikan ke topik.
steps.publishmessage.ExecutionError 500 Error ini terjadi jika terjadi error tak terduga saat memublikasikan pesan ke Pub/Sub. Anda dapat melihat detail error di pesan error.

Variabel kesalahan

Setiap kali terjadi error eksekusi dalam kebijakan, Apigee akan menghasilkan pesan error. Anda dapat melihat pesan error ini dalam respons error. Sering kali, pesan error yang dihasilkan sistem mungkin tidak relevan dalam konteks produk Anda. Anda mungkin ingin menyesuaikan pesan error berdasarkan jenis error agar pesan menjadi lebih bermakna.

Untuk menyesuaikan pesan error, Anda dapat menggunakan aturan kesalahan atau kebijakan RaiseFault. Untuk mengetahui informasi tentang perbedaan antara aturan fault dan kebijakan RaiseFault, lihat kebijakan FaultRules vs. RaiseFault. Anda harus memeriksa kondisi menggunakan elemen Condition di aturan fault dan kebijakan RaiseFault. Apigee menyediakan variabel kesalahan yang unik untuk setiap kebijakan dan nilai variabel kesalahan ditetapkan saat kebijakan memicu error runtime. Dengan menggunakan variabel ini, Anda dapat memeriksa kondisi error tertentu dan mengambil tindakan yang sesuai. Untuk mengetahui informasi selengkapnya tentang cara memeriksa kondisi error, lihat Kondisi build.

Variabel Dari mana Contoh
fault.name fault.name dapat cocok dengan kesalahan mana pun yang tercantum dalam tabel Error runtime. Nama kesalahan adalah bagian terakhir dari kode kesalahan. fault.name Matches "UnresolvedVariable"
publishmessage.POLICY_NAME.failed POLICY_NAME adalah nama kebijakan yang ditentukan pengguna yang menampilkan kesalahan. publishmessage.publish-message-1.failed = true
Untuk mengetahui informasi selengkapnya tentang error kebijakan, lihat Yang perlu Anda ketahui tentang error kebijakan