Halaman ini diterjemahkan oleh Cloud Translation API.

Kebijakan AssignMessage

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Apa

Kebijakan AssignMessage mengubah atau membuat pesan permintaan dan respons baru selama Flow proxy API. Kebijakan ini memungkinkan Anda melakukan tindakan berikut pada pesan tersebut:

Menambahkan parameter formulir, header, atau parameter kueri baru ke pesan
Menyalin properti yang ada dari satu pesan ke pesan lain
Menghapus header, parameter kueri, parameter formulir, dan/atau payload pesan dari pesan
Menetapkan nilai properti yang ada dalam pesan

Dengan kebijakan AssignMessage, Anda biasanya menambahkan, mengubah, atau menghapus properti permintaan atau respons. Namun, Anda juga dapat menggunakan kebijakan AssignMessage untuk membuat pesan permintaan atau respons kustom dan meneruskannya ke target alternatif, seperti yang dijelaskan dalam Membuat pesan permintaan kustom.

Kasus penggunaan

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

Tentukan nilai default untuk parameter string kueri atau jenis input lainnya.
Menghapus header HTTP dari pesan permintaan sebelum pesan diteruskan ke layanan backend.
Tambahkan header HTTP sebelum respons dikirim ke aplikasi konsumen.
Menyisipkan konten pesan JSON atau XML sebelum respons dikirim.
Membuat pesan permintaan atau respons yang lengkap. Misalnya, Anda dapat menggunakan kebijakan ServiceCallout untuk memanggil API jarak jauh dari proxy API. Anda dapat menggunakan kebijakan AssignMessage untuk membuat pesan permintaan kustom dan menetapkannya ke variabel. Kemudian, gunakan Panggilan Layanan untuk mengirim pesan tersebut ke API jarak jauh.
Tambahkan header ke permintaan dan respons untuk proses debug dan pemecahan masalah.

Kebijakan AssignMessage dapat membuat atau mengubah variabel alur dengan elemen turunan berikut:

Elemen `<AssignMessage>`

Menentukan kebijakan AssignMessage.

Nilai Default	Lihat tab Kebijakan Default di bawah
Wajib?	Wajib
Jenis	Objek kompleks
Elemen Induk	t/a
Elemen Turunan	`<Add>` `<AssignTo>` `<AssignVariable>` `<Copy>` `<DisplayName>` `<IgnoreUnresolvedVariables>` `<Remove>` `<Set>`

Elemen <AssignMessage> menggunakan sintaksis berikut:

Sintaksis

Elemen <AssignMessage> menggunakan sintaksis berikut:

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <!-- All AssignMessage 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>

  <AssignVariable>
    <Name>variable_name</Name>
    <Ref>source_variable</Ref>
    <Template>message_template</Template>
    or
    <Template ref='template_variable'></Template>
    <Value>variable_value</Value>
  </AssignVariable>

  <Copy source="[request|response]">
    <!-- Can also be an empty array (<FormParams/>) -->
    <FormParams>
      <FormParam name="formparam_name">formparam_value</FormParam>
      ...
    </FormParams>
    <!-- Can also be an empty array (<Headers/>) -->
    <Headers>
      <Header name="header_name">header_value</Header>
      ...
    </Headers>
    <Path>[false|true]</Path>
    <Payload>[false|true]</Payload>
    <!-- Can also be an empty array (<QueryParams/>) -->
    <QueryParams>
      <QueryParam name="queryparam_name">queryparam_value</QueryParam>
      ...
    </QueryParams>
    <ReasonPhrase>[false|true]</ReasonPhrase>
    <StatusCode>[false|true]</StatusCode>
    <Verb>[false|true]</Verb>
    <Version>[false|true]</Version>
  </Copy>

  <DisplayName>policy_display_name</DisplayName>

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

  <Remove>
    <!-- Can also be an empty array (<FormParams/>) -->
    <FormParams>
      <FormParam name="formparam_name">formparam_value</FormParam>
      ...
    </FormParams>
    <!-- Can also be an empty array (<Headers/>) -->
    <Headers>
      <Header name="header_name">header_value</Header>
      ...
    </Headers>
    <Payload>[false|true]</Payload>
    <!-- Can also be an empty array (<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>
    <Payload contentType="content_type" variablePrefix="prefix"
        variableSuffix="suffix">new_payload</Payload>
    <QueryParams>
      <QueryParam name="queryparam_name">queryparam_value</QueryParam>
      ...
    </QueryParams>
    <ReasonPhrase>reason_for_error or {variable}</ReasonPhrase>
    <StatusCode>HTTP_status_code or {variable}</StatusCode>
    <Verb>[GET|POST|PUT|PATCH|DELETE|{variable}]</Verb>
    <Version>[1.0|1.1|{variable}]</Verb>
  </Set>

</AssignMessage>

Kebijakan Default

Contoh berikut menunjukkan setelan default saat Anda menambahkan kebijakan AssignMessage ke alur di UI Edge:

<AssignMessage continueOnError="false" enabled="true" name="assign-message-default">
  <DisplayName>Assign Message-1</DisplayName>
  <Properties/>
  <Copy source="request">
    <Headers/>
    <QueryParams/>
    <FormParams/>
    <Payload/>
    <Verb/>
    <StatusCode/>
    <ReasonPhrase/>
    <Path/>
  </Copy>
  <Remove>
    <Headers>
      <Header name="h1"/>
    </Headers>
    <QueryParams>
      <QueryParam name="q1"/>
    </QueryParams>
    <FormParams>
      <FormParam name="f1"/>
    </FormParams>
    <Payload/>
  </Remove>
  <Add>
    <Headers/>
    <QueryParams/>
    <FormParams/>
  </Add>
  <Set>
    <Headers/>
    <QueryParams/>
    <FormParams/>
    <!-- <Verb>GET</Verb> -->
    <Path/>
  </Set>
  <AssignVariable>
    <Name>name</Name>
    <Value/>
    <Ref/>
  </AssignVariable>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

Saat Anda menyisipkan kebijakan AssignMessage baru di UI Edge, template 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 salin, gunakan elemen <Copy> dan hapus <Add>, <Remove>, dan elemen turunan lainnya dari kebijakan agar lebih mudah dibaca.

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. Secara opsional, gunakan elemen `<DisplayName>` untuk memberi label kebijakan di editor proxy UI pengelolaan dengan nama bahasa alami yang berbeda.
`continueOnError`	false	Opsional	Tetapkan ke "false" untuk menampilkan error saat kebijakan gagal. Hal ini wajar untuk sebagian besar kebijakan. Tetapkan ke "true" agar eksekusi flow berlanjut meskipun kebijakan gagal.
`enabled`	benar	Opsional	Tetapkan ke "true" untuk menerapkan kebijakan. Tetapkan ke "false" untuk "menonaktifkan" kebijakan. Kebijakan ini tidak akan diterapkan meskipun tetap dilampirkan ke flow.
`async`	false	Tidak digunakan lagi	Atribut ini tidak digunakan lagi.

Tabel berikut memberikan deskripsi umum tentang elemen turunan <AssignMessage>:

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. Untuk menimpa header atau parameter yang ada, gunakan elemen `<Set>`.
`<Copy>`	Opsional	Menyalin informasi dari pesan yang ditentukan oleh atribut `source` ke objek pesan yang ditentukan oleh elemen `<AssignTo>`.
`<Remove>`	Opsional	Menghapus elemen tertentu 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>` menggantikan header atau parameter yang sudah ada dalam pesan asli. Untuk menambahkan header atau parameter baru, gunakan elemen `<Add>`.
Elemen turunan lainnya
`<AssignTo>`	Opsional	Menentukan pesan mana yang dioperasikan oleh kebijakan AssignMessage. Ini dapat berupa permintaan atau respons standar, atau dapat berupa pesan kustom baru.
`<AssignVariable>`	Opsional	Menetapkan nilai ke variabel alur. Jika variabel tidak ada, maka `<AssignVariable>` akan membuatnya.
`<IgnoreUnresolvedVariables>`	Opsional	Menentukan apakah pemrosesan berhenti saat variabel yang belum diselesaikan ditemukan.

Setiap elemen turunan ini dijelaskan di bagian selanjutnya.

Contoh

Contoh berikut menunjukkan beberapa cara Anda dapat menggunakan kebijakan AssignMessage:

1: Tambahkan header

Contoh berikut menambahkan header ke permintaan dengan elemen <Add>:

<AssignMessage continueOnError="false" enabled="true" name="add-headers-1">
  <Add>
    <Headers>
      <Header name="user-agent">{request.user.agent}</Header>
    </Headers>
  </Add>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

2: Hapus payload

Contoh berikut menghapus payload dari respons dengan elemen <Remove>:

<AssignMessage continueOnError="false" enabled="true" name="remove-1">
  <DisplayName>remove-1</DisplayName>
  <Remove>
    <Payload>true</Payload>
  </Remove>
  <AssignTo createNew="false" transport="http" type="response"/>
</AssignMessage>

3: Mengubah respons

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

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

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

Karena contoh ini menghilangkan nama variabel dalam elemen <AssignTo>, dan menentukan type sebagai "response", kebijakan ini mengubah objek respons 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 Assign Message ini berisi header HTTP yang menunjukkan apakah hasil telah ditarik dari cache atau tidak. Menetapkan header dalam respons dapat berguna untuk proses debug dan pemecahan masalah.

4: Menetapkan konten dinamis

Anda dapat menggunakan Tetapkan Pesan untuk menyematkan konten dinamis dalam payload respons dan pesan permintaan.

Untuk menyematkan variabel alur Edge dalam payload XML, gabungkan variabel yang ditentukan dalam tanda kurung kurawal, seperti ini: {prefix.name}.

Contoh berikut menyematkan nilai variabel alur header HTTP user-agent dalam elemen XML yang disebut User-agent:

<AssignMessage name="set-dynamic-content">
  <AssignTo createNew="false" type="response"></AssignTo>
  <Set>
    <Payload contentType="text/xml">
      <User-agent>{request.header.user-agent}</User-agent>
    </Payload>
  </Set>
  <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
</AssignMessage>

Untuk payload JSON, Anda dapat menyisipkan variabel menggunakan atribut variablePrefix dan variableSuffix dengan karakter pembatas seperti yang ditunjukkan dalam contoh berikut:

<AssignMessage name="set-payload">
  <Payload contentType="application/json" variablePrefix="@" variableSuffix="#">
  {
     "user-agent": "@request.header.user-agent#"
  }
  </Payload>
</AssignMessage>

Untuk mengetahui daftar lengkap variabel alur, lihat Referensi variabel alur.

Mulai rilis cloud 16.08.17, Anda juga dapat menggunakan kurung kurawal untuk menyisipkan variabel.

5: Hapus parameter kueri

Contoh berikut menghapus parameter kueri apikey dari permintaan:

<AssignMessage name="remove-query-param">
  <Remove>
    <QueryParams>
      <QueryParam name="apikey"/>
    </QueryParams>
  </Remove>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

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.

6: Menetapkan/mendapatkan variabel

Contoh berikut menggunakan tiga kebijakan Tetapkan Pesan:

Membuat tiga variabel alur dalam permintaan, dengan nilai statis
Mendapatkan variabel alur secara dinamis dalam kebijakan kedua di alur permintaan
Menetapkannya dalam payload respons

<!-- Policy #1: Set variables in the request -->
<AssignMessage continueOnError="false" enabled="true" name="set-variables">
    <!-- Create a variable named myAppSecret -->
    <AssignVariable>
        <Name>myAppSecret</Name>
        <Value>42</Value>
    </AssignVariable>
    <!-- Create a variable named config.environment -->
    <AssignVariable>
        <Name>config.environment</Name>
        <Value>test</Value>
    </AssignVariable>
    <!-- Create a variable named config.protocol -->
    <AssignVariable>
        <Name>config.protocol</Name>
        <Value>gopher</Value>
    </AssignVariable>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

Dalam kebijakan pertama, elemen <AssignVariable> membuat dan menetapkan tiga variabel dalam permintaan. Setiap elemen <Name> menentukan nama variabel, dan <Value> menentukan nilai.

Kebijakan kedua menggunakan elemen <AssignVariable> untuk membaca nilai dan membuat tiga variabel baru:

<!-- Policy #2: Get variables from the request -->
<AssignMessage continueOnError="false" enabled="true" name="get-variables">
  <AssignTo createNew="false" transport="http" type="request"/>
  <!-- Get the value of myAppSecret and create a new variable, secret -->
  <AssignVariable>
    <Name>secret</Name>
    <Ref>myAppSecret</Ref>
    <Value>0</Value>
  </AssignVariable>
  <!-- Get the value of config.environment and create a new variable, environment -->
  <AssignVariable>
    <Name>environment</Name>
    <Ref>config.environment</Ref>
    <Value>default</Value>
  </AssignVariable>
  <!-- Get the value of config.protocol and create a new variable, protocol -->
  <AssignVariable>
    <Name>protocol</Name>
    <Ref>config.protocol</Ref>
    <Value>default</Value>
  </AssignVariable>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</AssignMessage>

Dalam kebijakan kedua, elemen <Ref> mereferensikan variabel sumber, dan elemen <Name> menentukan nama variabel baru. Jika variabel yang dirujuk oleh elemen <Ref> tidak dapat diakses, Anda dapat menggunakan nilai yang ditentukan oleh elemen <Value>.

Untuk mencoba kumpulan kebijakan ini:

Tambahkan kebijakan #1 dan #2 ke alur permintaan. Pastikan untuk menempatkan kebijakan #1 sebelum kebijakan #2.
Tambahkan kebijakan ketiga dalam alur respons.

Kebijakan ketiga menggunakan elemen <Set> untuk menambahkan variabel ke respons. Contoh berikut membuat payload XML dalam respons yang ditampilkan Edge ke klien:

<!-- Policy #3: Add variables to the response -->
<AssignMessage continueOnError="false" enabled="true" name="put-em-in-the-payload">
  <DisplayName>put-em-in-the-payload</DisplayName>
  <Set>
    <Payload contentType="application/xml">
      <wrapper>
        <secret>{secret}</secret>
        <config>
          <environment>{environment}</environment>
          <protocol>{protocol}</protocol>
        </config>
      </wrapper>
    </Payload>
  </Set>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <AssignTo createNew="false" transport="http" type="response"/>
</AssignMessage>

Perhatikan bahwa sintaksis untuk mengakses variabel alur di <Set> adalah dengan menyertakannya dalam kurung kurawal.

Pastikan untuk menyetel atribut contentType elemen <Payload> ke "application/xml".

Kirim permintaan ke proxy API Anda; misalnya:

curl -vL https://ahamilton-eval-test.apigee.net/myproxy

Jika ingin, Anda dapat menyalurkan hasil melalui utilitas seperti xmllint sehingga XML ditampilkan dalam struktur yang diformat dengan baik:

curl -vL https://ahamilton-eval-test.apigee.net/myproxy | xmllint --format -

Isi respons akan terlihat seperti berikut:

<wrapper>
  <secret>42</secret>
  <config>
    <environment>test</environment>
    <protocol>gopher</protocol>
  </config>
</wrapper>

7: Mendapatkan header respons Service Callout

Dalam contoh berikut, misalkan kebijakan ServiceCallout ada dalam permintaan proxy API, dan respons callout berisi beberapa header dengan nama yang sama (Set-Cookie). Dengan asumsi variabel respons Service Callout adalah calloutResponse default, kebijakan berikut akan mendapatkan nilai header Set-Cookie kedua.

<AssignMessage continueOnError="false" enabled="true" name="get-header">
  <Set>
    <Payload contentType="application/json">
      {"Cookies from Service Callout":" {calloutResponse.header.Set-Cookie.2}"}
    </Payload>
  </Set>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

Untuk mencantumkan semua nilai header, gunakan variabel berikut:

{calloutResponse.header.Set-Cookie.values}

Setiap elemen turunan dalam referensi ini memiliki contoh tambahan. Untuk contoh lainnya, lihat contoh AssignMessage di GitHub.

Referensi elemen turunan

Bagian ini menjelaskan elemen turunan <AssignMessage>.

`<Add>`

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

Elemen <Add> menambahkan properti baru pada pesan yang tidak ada di pesan asli. Untuk mengubah nilai properti yang ada, gunakan elemen <Set>.

Nilai Default	t/a
Wajib?	Opsional
Jenis	Jenis kompleks
Elemen Induk	`<AssignMessage>`
Elemen Turunan	`<FormParams>` `<Headers>` `<QueryParams>`

Elemen <Add> menggunakan sintaksis berikut:

Sintaksis

<AssignMessage
    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>
</AssignMessage>

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:

<AssignMessage continueOnError="false" enabled="true" name="add-formparams-3">
  <Add>
    <FormParams>
      <FormParam name="name">{request.queryparam.name}</FormParam>
      <FormParam name="zip">{request.queryparam.zipCode}</FormParam>
      <FormParam name="lang">{request.queryparam.lang}</FormParam>
    </FormParams>
  </Add>
  <AssignTo transport="http" type="request"/>
</AssignMessage>

Contoh 2

Contoh berikut menggunakan elemen <Headers> untuk menambahkan header User-Agent ke permintaan endpoint target:

<AssignMessage continueOnError="false" enabled="true" name="add-headers-1">
  <Add>
    <Headers>
      <Header name="user-agent">{request.user.agent}</Header>
    </Headers>
  </Add>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

Contoh 3

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

<AssignMessage continueOnError="false" enabled="true" name="add-queryparams-1">
  <Add>
    <QueryParams>
      <QueryParam name="myParam">42</QueryParam>
    </QueryParams>
  </Add>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

Contoh ini menggunakan <Add> dalam preflow permintaan. Jika Anda melihat hasilnya di alat seperti Trace tool, permintaan ke "http://httpbin.org/get" akan menjadi "http://httpbin.org/get?myParam=42".

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

`<FormParams>` (anak 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:

Sintaksis

<AssignMessage
    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>
</AssignMessage>

Contoh 1

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

<AssignMessage continueOnError="false" enabled="true" name="add-formparams-1">
  <Add>
    <FormParams>
      <FormParam name="answer">42</FormParam>
    </FormParams>
  </Add>
  <AssignTo transport="http" type="request"></AssignTo>
</AssignMessage>

Contoh 2

Contoh berikut mendapatkan nilai parameter string kueri name dan menambahkannya ke permintaan sebagai parameter formulir:

<AssignMessage continueOnError="false" enabled="true" name="add-formparams-2">
  <Add>
    <FormParam name="name">{request.queryparam.name}</FormParam>
  </Add>
</AssignMessage>

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:

<AssignMessage continueOnError="false" enabled="true" name="add-formparams-3">
  <Add>
    <FormParams>
      <FormParam name="name">{request.queryparam.name}</FormParam>
      <FormParam name="zip">{request.queryparam.zipCode}</FormParam>
      <FormParam name="lang">{request.queryparam.lang}</FormParam>
    </FormParams>
  </Add>
  <AssignTo transport="http" type="request"/>
</AssignMessage>

Contoh ini mendapatkan parameter string kueri dari permintaan asal dan menambahkannya sebagai parameter formulir ke permintaan yang dikirim ke endpoint target.

Anda dapat menggunakan alat Pelacakan untuk melihat alurnya. Anda akan melihat bahwa isi permintaan berisi data formulir yang dienkode ke URL, yang awalnya diteruskan sebagai parameter string kueri:

%7Busername%7D=nick&%7Bzip_code%7D=90210&%7Bdefault_language%7D=en

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

Kata kerja HTTP: POST
Jenis pesan: Permintaan
Salah satu (atau kedua) hal berikut:
- Data formulir: Ditetapkan ke beberapa nilai, atau "" (string kosong). Misalnya, dengan curl, tambahkan -d "" ke permintaan Anda.
- header Content-Length: Setel 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>, Edge akan menyetel header Content-Type permintaan ke "application/x-www-form-urlencoded" sebelum mengirim pesan ke layanan target.

`<Headers>` (anak 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:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Add>
    <Headers>
      <Header name="header_name">header_value</Header>
      ...
    </Headers>
  </Add>
</AssignMessage>

Contoh 1

Contoh berikut menambahkan header user-agent ke pesan permintaan, dan menetapkan nilai variabel alur request.user.agent ke header tersebut.

<AssignMessage continueOnError="false" enabled="true" name="add-headers-1">
  <Add>
    <Headers>
      <Header name="user-agent">{request.user.agent}</Header>
    </Headers>
  </Add>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

`<QueryParams>` (anak dari `<Add>`)

Menambahkan parameter kueri baru ke permintaan. Elemen ini tidak memengaruhi respons.

Nilai Default	t/a
Wajib?	Opsional
Jenis	Array elemen `<QueryParam>`
Elemen Induk	`<Add>`
Elemen Turunan	`<QueryParam>`

Elemen <QueryParams> menggunakan sintaksis berikut:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Add>
    <QueryParams>
      <QueryParam name="queryparam_name">queryparam_value</QueryParam>
      ...
    </QueryParams>
  </Add>
</AssignMessage>

Contoh 1

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

<AssignMessage continueOnError="false" enabled="true" name="add-queryparams-1">
  <Add>
    <QueryParams>
      <QueryParam name="myParam">42</QueryParam>
    </QueryParams>
  </Add>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

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

Kata kerja HTTP: GET
Jenis pesan: Permintaan

Selain itu, Anda hanya dapat menetapkan parameter kueri jika atribut type elemen <AssignTo> adalah pesan permintaan. Menyetelnya 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 menghilangkan <QueryParams>.

`<AssignTo>`

Menentukan objek mana yang dioperasikan oleh kebijakan AssignMessage. 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 AssignMessage 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	`<AssignMessage>`
Elemen Turunan	Tidak ada

Jika Anda tidak menentukan <AssignTo>, kebijakan akan bertindak pada permintaan atau respons default, yang didasarkan pada tempat kebijakan dijalankan. Jika kebijakan dijalankan dalam alur permintaan, kebijakan tersebut akan memengaruhi pesan permintaan. Jika dijalankan dalam alur respons, kebijakan akan memengaruhi respons secara default.

Elemen <AssignTo> menggunakan sintaksis berikut:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <AssignTo createNew="[true|false]" transport="http"
    type="[request|response]">destination_variable_name</AssignTo>
</AssignMessage>

Contoh 1

Contoh berikut menentukan bahwa target adalah permintaan asli yang akan dikirim ke endpoint target:

<AssignMessage name="assignto-1">
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

Dengan menyetel createNew ke "false" (default), contoh ini tidak membuat permintaan baru. Semua operasi dalam kebijakan ini memengaruhi permintaan asli.

Contoh 2

Contoh berikut membuat objek permintaan baru:

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

Saat Anda membuat objek permintaan atau respons baru, elemen kebijakan AssignMessage lainnya (seperti <Add>, <Set>, dan <Set>) akan bertindak pada objek permintaan baru tersebut.

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

Contoh 3

Contoh berikut membuat objek permintaan baru bernama "MyRequestObject":

<AssignMessage name="assignto-2">
  <AssignTo createNew="true" transport="http" type="request"&gt;MyRequestObject&lt;/AssignTo>
</AssignMessage>

Saat Anda membuat objek permintaan atau respons baru, elemen kebijakan AssignMessage lainnya (seperti <Add>, <Set>, dan <Set>) akan bertindak pada objek permintaan baru tersebut.

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

Tabel berikut menjelaskan atribut <AssignTo>:

Atribut Deskripsi Wajib? Jenis

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` (baik "request" atau "response"). Jika Anda tidak menentukan nama variabel baru, kebijakan akan membuat objek permintaan atau 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: Jika `<AssignTo>` dapat menyelesaikan nama variabel ke permintaan atau respons, maka 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, maka kebijakan akan menampilkan error. Jika `createNew` tidak ditentukan, kebijakan akan merespons dengan salah satu dari dua cara: Jika `<AssignTo>` diselesaikan ke pesan, pemrosesan akan dilanjutkan ke langkah berikutnya. Jika `<AssignTo>` tidak dapat diselesaikan, atau diselesaikan ke jenis non-pesan, variabel baru dengan jenis yang ditentukan dalam `type` akan dibuat.	Opsional	Boolean
`transport`	Menentukan jenis transportasi 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, Edge akan membuat permintaan atau respons, bergantung pada tempat kebijakan ini dijalankan dalam alur.	Opsional	String

createNew

Menentukan apakah kebijakan ini membuat pesan baru saat menetapkan nilai.

Jika "true", kebijakan akan membuat variabel baru dari jenis yang ditentukan oleh type (baik "request" atau "response"). Jika Anda tidak menentukan nama variabel baru, kebijakan akan membuat objek permintaan atau respons baru, berdasarkan nilai type.

Jika "false", kebijakan akan merespons dengan salah satu dari dua cara:

Jika <AssignTo> dapat menyelesaikan nama variabel ke permintaan atau respons, maka 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, maka kebijakan akan menampilkan error.

Jika createNew tidak ditentukan, kebijakan akan merespons dengan salah satu dari dua cara:

Jika <AssignTo> diselesaikan ke pesan, pemrosesan akan dilanjutkan ke langkah berikutnya.
Jika <AssignTo> tidak dapat diselesaikan, atau diselesaikan ke jenis non-pesan, variabel baru dengan jenis yang ditentukan dalam type akan dibuat.

Opsional

Boolean

transport

Menentukan jenis transportasi 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, Edge akan membuat permintaan atau respons, bergantung pada tempat kebijakan ini dijalankan dalam alur.

Opsional

String

`<AssignVariable>`

Menetapkan nilai ke variabel alur tujuan (misalnya, variabel yang nilainya ditetapkan oleh kebijakan AssignMessage). Jika variabel alur tidak ada, <AssignVariable> akan membuatnya.

Nilai Default	t/a
Wajib?	Opsional
Jenis	Jenis kompleks
Elemen Induk	`<AssignMessage>`
Elemen Turunan	`<Name>` (wajib) `<Ref>` `<Template>` `<Value>`

Nilai yang Anda tetapkan ke variabel alur tujuan dapat berupa salah satu dari berikut ini:

String literal: Gunakan elemen turunan <Value> untuk menentukan nilai string literal untuk variabel alur tujuan.
Variabel alur: Gunakan elemen turunan <Ref> untuk menentukan nilai variabel alur yang ada untuk variabel alur tujuan. Untuk daftar lengkap variabel alur yang dapat digunakan sebagai sumber, lihat Referensi variabel alur.
Template pesan: Gunakan elemen turunan <Template> untuk menentukan template pesan untuk variabel alur tujuan.

Elemen <AssignVariable> menggunakan sintaksis berikut:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <AssignVariable>
    <Name>variable_name</Name>
    <Ref>source_variable</Ref>
    <Template>message_template</Template>
    or
    <Template ref='template_variable'></Template>
    <Value>variable_value</Value>
  </AssignVariable>
</AssignMessage>

Gunakan elemen <Ref> untuk menentukan variabel sumber. Jika variabel yang dirujuk oleh <Ref> tidak dapat diakses, Edge akan menggunakan nilai yang ditentukan oleh elemen <Value>. Jika Anda menentukan <Template>, elemen tersebut akan lebih diprioritaskan daripada elemen turunan lainnya.

Contoh 1

Contoh berikut menetapkan nilai variabel baru, myvar, ke nilai literal "42":

<AssignMessage name="assignvariable-1">
  <AssignVariable>
    <Name>myvar</Name>
    <Value>42</Value>
  </AssignVariable>
</AssignMessage>

Contoh 2

Contoh berikut menetapkan nilai variabel alur request.header.user-agent ke variabel alur tujuan myvar dan nilai parameter kueri country ke variabel alur tujuan Country:

<AssignMessage name="assignvariable-2">
  <AssignVariable>
    <Name>myvar</Name>
    <Ref>request.header.user-agent</Ref>
    <Value>ErrorOnCopy</Value>
  </AssignVariable>
  <AssignVariable>
    <Name>Country</Name>
    <Ref>request.queryparam.country</Ref>
    <Value>ErrorOnCopy</Value>
  </AssignVariable>
</AssignMessage>

Jika salah satu penetapan gagal, Edge akan menetapkan nilai "ErrorOnCopy" ke variabel alur tujuan.

Jika variabel alur myvar atau Country tidak ada, <AssignVariable> akan membuatnya.

Contoh 3

Contoh berikut menggunakan elemen turunan <Template> untuk menggabungkan dua variabel konteks dengan string literal (tanda hubung) di antaranya:

<AssignMessage name='template-1'>
  <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
  <AssignVariable>
    <Name>my_destination_variable</Name>
    <Value>BADDBEEF</Value>
    <Template>{system.uuid}-{messageid}</Template>
  </AssignVariable>
</AssignMessage>

Penggunaan umum untuk <AssignVariable> adalah untuk menetapkan nilai default untuk parameter kueri, header, atau nilai lain yang dapat diteruskan dengan permintaan. Anda melakukannya dengan kombinasi elemen turunan <Ref> dan <Value>. Untuk informasi selengkapnya, lihat contoh untuk <Ref>.

`<Name>` (anak dari `<AssignVariable>`)

Menentukan nama variabel alur tujuan (misalnya, variabel yang nilainya ditetapkan oleh kebijakan AssignMessage). Jika variabel yang disebutkan dalam <AssignVariable> tidak ada, kebijakan akan membuat variabel dengan nama tersebut.

Nilai Default	t/a
Wajib?	Wajib
Jenis	String
Elemen Induk	`<AssignVariable>`
Elemen Turunan	Tidak ada

Elemen <Name> menggunakan sintaksis berikut:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <AssignVariable>
    <Name>variable_name</Name>
  </AssignVariable>
</AssignMessage>

Contoh 1

Contoh berikut menentukan variabel tujuan sebagai myvar, dan menyetelnya ke nilai literal "42":

<AssignMessage name="assignvariable-1">
  <AssignVariable>
    <Name>myvar</Name>
    <Value>42</Value>
  </AssignVariable>
</AssignMessage>

Jika myvar tidak ada, <AssignVariable> akan membuatnya.

`<Ref>` (anak dari `<AssignVariable>`)

Menentukan sumber penetapan sebagai variabel alur. Variabel alur dapat berupa salah satu variabel alur yang telah ditentukan sebelumnya (seperti yang tercantum dalam Referensi variabel alur), atau variabel alur kustom yang Anda buat.

Nilai <Ref> selalu ditafsirkan sebagai variabel alur; Anda tidak dapat menentukan string literal sebagai nilai. Untuk menetapkan nilai string literal, gunakan elemen <Value> sebagai gantinya.

Nilai Default	t/a
Wajib?	Opsional
Jenis	String
Elemen Induk	`<AssignVariable>`
Elemen Turunan	Tidak ada

Saat Anda menentukan variabel alur dengan <Ref>, hilangkan tanda kurung "{}" yang biasanya Anda gunakan untuk mereferensikan variabel alur. Misalnya, untuk menyetel nilai variabel baru Anda ke nilai variabel alur client.host:

Do this (no brackets):
  <Ref>client.host</Ref>

Do NOT do this (brackets):
  <Ref>{client.host}</Ref>

Untuk menentukan nilai default untuk variabel tujuan flow, gunakan <Value> bersama dengan <Ref>. Jika variabel alur yang ditentukan oleh <Ref> tidak ada, tidak dapat dibaca, atau bernilai null, Edge akan menetapkan nilai <Value> ke variabel alur tujuan.

Elemen <Ref> menggunakan sintaksis berikut:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <AssignVariable>
    <Name>variable_name</Name>
    <Ref>source_variable</Ref>
  </AssignVariable>
</AssignMessage>

Contoh 1

Contoh berikut menetapkan nilai variabel alur request.header.user-agent ke variabel alur tujuan myvar dan nilai parameter kueri country ke variabel Country:

<AssignMessage name="assignvariable-4">
  <AssignVariable>
    <Name>myvar</Name>
    <Ref>request.header.user-agent</Ref>
  </AssignVariable>
  <AssignVariable>
    <Name>Country</Name>
    <Ref>request.queryparam.country</Ref>
  </AssignVariable>
</AssignMessage>

Dalam contoh ini, Edge tidak memiliki default (atau nilai penggantian) yang ditentukan untuk penugasan.

Contoh 2

Contoh berikut menetapkan nilai variabel alur request.header.user-agent ke variabel alur tujuan myvar dan nilai parameter kueri country ke variabel Country:

<AssignMessage name="assignvariable-2">
  <AssignVariable>
    <Name>myvar</Name>
    <Ref>request.header.user-agent</Ref>
    <Value>ErrorOnCopy</Value>
  </AssignVariable>
  <AssignVariable>
    <Name>Country</Name>
    <Ref>request.queryparam.country</Ref>
    <Value>ErrorOnCopy</Value>
  </AssignVariable>
</AssignMessage>

Dalam contoh ini, jika nilai variabel alur request.header.user-agent atau parameter kueri Country bernilai null, tidak dapat dibaca, atau salah bentuk, Edge akan menetapkan nilai "ErrorOnCopy" ke variabel baru.

Contoh 3

Kasus penggunaan umum untuk <AssignVariable> adalah menetapkan nilai default kueri parameter, header, atau nilai lain yang dapat diteruskan dengan permintaan. Misalnya, Anda membuat proxy API cuaca dengan permintaan yang menggunakan satu parameter kueri bernama "w". Parameter ini berisi ID kota yang ingin Anda ketahui cuacanya. URL permintaan memiliki format:

http://myCO.com/v1/weather/forecastrss?w=city_ID

Untuk menentukan nilai default untuk "w", buat kebijakan AssignMessage seperti berikut:

<AssignMessage continueOnError="false" enabled="true" name="assignvariable-3">
  <AssignTo createNew="false" transport="http" type="request"/>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <AssignVariable>
    <Name>request.queryparam.w</Name>
    <Ref>request.queryparam.w</Ref>
    <Value>12797282</Value>
  </AssignVariable>
</AssignMessage>

Dalam contoh ini, <AssignVariable> mendapatkan nilai request.queryparam.w dan menetapkannya ke dirinya sendiri. Jika variabel alur bernilai null, yang berarti parameter kueri "w" tidak ada dalam permintaan, contoh ini akan menggunakan nilai default dari elemen <Value>. Oleh karena itu, Anda dapat membuat permintaan ke proxy API ini yang menghilangkan parameter kueri "w":

http://myCO.com/v1/weather/forecastrss

...dan tetap membuat proxy API menampilkan hasil yang valid.

Tidak seperti saat menggunakan <Value>, nilai <Ref> harus berupa variabel alur, seperti properti objek request, response, atau target. Nilai juga dapat berupa variabel alur kustom yang Anda buat.

Jika Anda menentukan variabel alur yang tidak ada untuk nilai <Ref>, dan nilai <IgnoreUnresolvedVariables> adalah "true", Edge akan menampilkan error.

`<Template>` (anak dari `<AssignVariable>`)

Menentukan template pesan. Template pesan memungkinkan Anda melakukan penggantian string variabel saat kebijakan dijalankan, dan dapat menggabungkan string literal dengan nama variabel yang diapit tanda kurung kurawal. Selain itu, template pesan mendukung fungsi seperti escaping dan konversi huruf.

Gunakan atribut ref untuk menentukan variabel alur tempat nilai variabel adalah template pesan. Misalnya, Anda dapat menyimpan template pesan sebagai atribut kustom di aplikasi developer. Saat Edge mengidentifikasi aplikasi developer setelah memverifikasi kunci API atau token keamanan (melalui kebijakan tambahan), elemen <AssignVariable> dapat menggunakan template pesan dari atribut kustom aplikasi, yang tersedia sebagai variabel alur dari kebijakan keamanan. Contoh berikut mengasumsikan bahwa template pesan tersedia di atribut pelanggan yang disebut message_template di aplikasi developer yang melakukan panggilan API, dengan VerifyAPIKey policy digunakan untuk memverifikasi kunci API aplikasi:

<AssignVariable ref='verifyapikey.myVerifyAPIKeyPolicy.app.name.message_template'/>

Nilai Default	t/a
Wajib?	Opsional
Jenis	String
Elemen Induk	`<AssignVariable>`
Elemen Turunan	Tidak ada

Elemen <Template> menggunakan sintaksis berikut:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <AssignVariable>
    <Template>message_template</Template>
    or
    <Template ref='template_variable'></Template>
  </AssignVariable>
</AssignMessage>

Contoh 1

Contoh berikut menggunakan sintaksis pembuatan template pesan untuk menggabungkan dua variabel konteks dengan string literal (tanda hubung) di antaranya:

<AssignMessage name='template-1'>
  <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
  <AssignVariable>
    <Name>my_destination_variable</Name>
    <Value>BADDBEEF</Value>
    <Template>{system.uuid}-{messageid}</Template>
  </AssignVariable>
</AssignMessage>

Contoh 2

Contoh berikut menentukan variabel alur, dengan nilai variabel adalah template pesan yang telah ditentukan sebelumnya. Gunakan opsi ini jika Anda ingin menyuntikkan template yang telah ditentukan sebelumnya saat runtime tanpa harus mengubah kebijakan:

<AssignMessage name='template-2'>
  <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
  <AssignVariable>
    <Name>my_destination_variable</Name>
    <Value>BADDBEEF</Value>
    <Template ref='my_template_variable'/>

  </AssignVariable>
</AssignMessage>

Contoh 3

Contoh berikut menentukan variabel alur dan nilai teks. Dalam hal ini, jika variabel yang dirujuk tidak null, nilai tersebut akan digunakan sebagai template. Jika nilai yang direferensikan adalah null, maka nilai teks (dalam hal ini, {system.uuid}-{messageid}) akan digunakan sebagai template. Pola ini berguna untuk memberikan nilai "penggantian", yang dalam beberapa kasus, Anda ingin mengganti template default (bagian teks) dengan nilai yang ditetapkan secara dinamis. Misalnya, pernyataan kondisional dapat mengambil nilai dari peta nilai kunci dan menetapkan variabel yang dirujuk ke nilai tersebut:

<AssignMessage name='template-2'>
  <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
  <AssignVariable>
    <Name>my_destination_variable</Name>
    <Value>BADDBEEF</Value>
    <Template ref='my_variable'>{system.uuid}-{messageid}</Template>
  </AssignVariable>
</AssignMessage>

`<Value>` (anak dari `<AssignVariable>`)

Menentukan nilai variabel flow tujuan yang ditetapkan dengan <AssignVariable>. Nilai selalu ditafsirkan sebagai string literal; Anda tidak dapat menggunakan variabel alur sebagai nilai, meskipun Anda menyertakan nilai dalam tanda kurung ("{}"). Untuk menggunakan variabel alur, gunakan <Ref> sebagai gantinya.

Nilai Default	t/a
Wajib?	Opsional
Jenis	String
Elemen Induk	`<AssignVariable>`
Elemen Turunan	Tidak ada

Jika digunakan bersama dengan elemen <Ref>, <Value> bertindak sebagai nilai default (atau penggantian). Jika <Ref> tidak ditentukan, tidak dapat diselesaikan, atau null, nilai <Value> akan digunakan.

Elemen <Value> menggunakan sintaksis berikut:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <AssignVariable>
    <Name>variable_name</Name>
    <Value>variable_value</Value>
  </AssignVariable>
</AssignMessage>

Contoh 1

Contoh berikut menetapkan nilai variabel flow tujuan, myvar, ke nilai literal "42":

<AssignMessage name="assignvariable-1">
  <AssignVariable>
    <Name>myvar</Name>
    <Value>42</Value>
  </AssignVariable>
</AssignMessage>

Contoh 2

Contoh berikut menetapkan nilai variabel alur request.header.user-agent ke variabel alur myvar dan nilai parameter kueri country ke variabel Country:

<AssignMessage name="assignvariable-2">
  <AssignVariable>
    <Name>myvar</Name>
    <Ref>request.header.user-agent</Ref>
    <Value>ErrorOnCopy</Value>
  </AssignVariable>
  <AssignVariable>
    <Name>Country</Name>
    <Ref>request.queryparam.country</Ref>
    <Value>ErrorOnCopy</Value>
  </AssignVariable>
</AssignMessage>

Jika salah satu penetapan gagal, <AssignVariable> akan menetapkan nilai "ErrorOnCopy" ke variabel alur tujuan.

`<Copy>`

Menyalin nilai dari pesan yang ditentukan oleh atribut source ke pesan yang ditentukan oleh elemen <AssignTo>. Jika Anda tidak menentukan target dengan <AssignTo>, kebijakan ini akan menyalin nilai ke permintaan atau respons, bergantung pada tempat kebijakan ini dijalankan dalam alur.

Nilai Default	t/a
Wajib?	Opsional
Jenis	String
Elemen Induk	`<AssignMessage>`
Elemen Turunan	`<FormParams>` `<Headers>` `<Path>` `<Payload>` `<QueryParams>` `<ReasonPhrase>` `<StatusCode>` `<Verb>` `<Version>`

Elemen <Copy> menggunakan sintaksis berikut:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
    <Copy source="[request|response]">
    <!-- Can also be an empty array (<FormParams/>) -->
    <FormParams>
      <FormParam name="formparam_name">formparam_value</FormParam>
      ...
    </FormParams>
    <!-- Can also be an empty array (<Headers/>) -->
    <Headers>
      <Header name="header_name">header_value</Header>
      ...
    </Headers>
    <Path>[false|true]</Path>
    <Payload>[false|true]</Payload>
    <!-- Can also be an empty array (<QueryParams/>) -->
    <QueryParams>
      <QueryParam name="queryparam_name">queryparam_value</QueryParam>
      ...
    </QueryParams>
    <ReasonPhrase>[false|true]</ReasonPhrase>
    <StatusCode>[false|true]</StatusCode>
    <Verb>[false|true]</Verb>
    <Version>[false|true]</Version>
  </Copy>
  <!-- Used as the destination for the <Copy> values -->
  <AssignTo createNew="[true|false]" transport="http"
    type="[request|response]">destination_variable_name</AssignTo>
</AssignMessage>

Contoh 1

Contoh berikut menyalin header, tiga parameter formulir, jalur, dan semua parameter kueri dari permintaan ke permintaan kustom baru:

<AssignMessage continueOnError="false" enabled="true" name="copy-1">
  <Copy source="request">
    <Headers>
      <Header name="Header_Name_1">Header value 1</Header>
    </Headers>
    <FormParams>
      <FormParam name="Form_Param_Name_1">Form param value 1</FormParam>
      <FormParam name="Form_Param_Name_2">Form param value 1</FormParam>
      <FormParam name="Form_Param_Name_3">Form param value 1</FormParam>
    </FormParams>
    <Payload>false</Payload>
    <Path>true</Path>
    <QueryParams/>
    <ReasonPhrase>false</ReasonPhrase>
    <StatusCode>false</StatusCode>
    <Verb>false</Verb>
    <Version>false</Version>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request"/>
</AssignMessage>

Elemen <Copy> memiliki atribut berikut:

Atribut Deskripsi Wajib? Jenis

source

Atribut	Deskripsi	Wajib?	Jenis
source	Menentukan objek sumber salinan. Jika `source` tidak ditentukan, pesan akan diperlakukan sebagai pesan sederhana. Misalnya, jika kebijakan berada dalam alur permintaan, maka sumber secara default adalah objek `request`. Jika kebijakan ada dalam alur respons, kebijakan akan ditetapkan secara default ke objek `response`. Jika Anda menghilangkan `source`, Anda dapat menggunakan referensi absolut ke variabel alur sebagai sumber salinan. Misalnya, tentukan nilai sebagai `{request.header.user-agent}`. Jika variabel sumber tidak dapat diselesaikan, atau diselesaikan ke jenis non-pesan, `<Copy>` gagal merespons.	Opsional	String

Menentukan objek sumber salinan.

Jika source tidak ditentukan, pesan akan diperlakukan sebagai pesan sederhana. Misalnya, jika kebijakan berada dalam alur permintaan, maka sumber secara default adalah objek request. Jika kebijakan ada dalam alur respons, kebijakan akan ditetapkan secara default ke objek response. Jika Anda menghilangkan source, Anda dapat menggunakan referensi absolut ke variabel alur sebagai sumber salinan. Misalnya, tentukan nilai sebagai {request.header.user-agent}.
Jika variabel sumber tidak dapat diselesaikan, atau diselesaikan ke jenis non-pesan, <Copy> gagal merespons.

Opsional

String

`<FormParams>` (anak dari `<Copy>`)

Menyalin parameter formulir dari permintaan yang ditentukan oleh atribut source elemen <Copy> ke permintaan yang ditentukan oleh elemen <AssignTo>. Elemen ini tidak memengaruhi respons.

Nilai Default	t/a
Wajib?	Opsional
Jenis	Array elemen `<FormParam>` atau array kosong
Elemen Induk	`<Copy>`
Elemen Turunan	`<FormParam>`

Elemen <FormParams> menggunakan sintaksis berikut:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Copy source="[request|response]">
    <!-- Can also be an empty array (<FormParams/>) -->
    <FormParams>
      <FormParam name="formparam_name">formparam_value</FormParam>
      ...
    </FormParams>
  </Copy>
</AssignMessage>

Contoh 1

Contoh berikut menyalin satu parameter formulir dari permintaan ke permintaan kustom "MyCustomRequest":

<AssignMessage name="copy-formparams-1">
  <Copy source="request">
    <FormParams>
      <FormParam name="paramName">Form param value 1</FormParam>
    </FormParams>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request">MyCustomRequest</AssignTo>
</AssignMessage>

Contoh 2

Contoh berikut menyalin semua parameter formulir ke permintaan kustom "MyCustomRequest":

<AssignMessage name="copy-formparams-2">
  <Copy source="request">
    <FormParams/>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request">MyCustomRequest</AssignTo>
</AssignMessage>

Contoh 3

Contoh berikut menyalin tiga parameter formulir ke permintaan kustom "MyCustomRequest":

<AssignMessage name="copy-formparams-3">
  <Copy source="request">
    <FormParams>
      <FormParam name="paramName1"/>
      <FormParam name="paramName2"/>
      <FormParam name="paramName3"/>
    </FormParams>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request">MyCustomRequest</AssignTo>
</AssignMessage>

Contoh 4

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

<AssignMessage name="copy-formparams-4">
  <Copy source="request">
    <FormParams>
      <FormParam name="f1"/>
      <FormParam name="f2"/>
      <FormParam name="f3.2"/>
    </FormParams>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request">MyCustomRequest</AssignTo>
</AssignMessage>

Contoh ini menyalin "f1", "f2", dan nilai kedua "f3". Jika "f3" hanya memiliki satu nilai, maka nilai tersebut tidak disalin.

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

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

Saat Anda menyalin <FormParams>, <Copy> akan menetapkan Content-Type pesan ke "application/x-www-form-urlencoded" sebelum mengirim pesan ke layanan target.

`<Headers>` (anak dari `<Copy>`)

Menyalin header HTTP dari pesan permintaan atau respons yang ditentukan oleh atribut source elemen <Copy> ke pesan permintaan atau respons yang ditentukan oleh elemen <AssignTo>.

Nilai Default	t/a
Wajib?	Opsional
Jenis	Array elemen `<Header>` atau array kosong
Elemen Induk	`<Copy>`
Elemen Turunan	`<Header>`

Elemen <Headers> menggunakan sintaksis berikut:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Copy source="[request|response]">
    <!-- Can also be an empty array (<Headers/>) -->
    <Headers>
      <Header name="header_name">header_value</Header>
      ...
    </Headers>
  </Copy>
</AssignMessage>

Contoh 1

Contoh berikut menyalin header user-agent dari permintaan ke objek permintaan kustom yang baru:

<AssignMessage name="copy-headers-1">
  <Copy source="request">
    <Headers>
      <Header name="user-agent"/>
    </Headers>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request">MyCustomRequest</AssignTo>
</AssignMessage>

Contoh 2

Untuk menyalin semua header, gunakan elemen <Headers> kosong, seperti yang ditunjukkan dalam contoh berikut:

<AssignMessage name="copy-headers-2">
  <Copy source="request">
    <Headers/>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request">MyCustomRequest</AssignTo>
</AssignMessage>

Contoh 3

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

<AssignMessage name="copy-headers-3">
  <Copy source="request">
    <Headers>
      <Header name="h1"/>
      <Header name="h2"/>
      <Header name="h3.2"/>
    </Headers>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request">MyCustomRequest</AssignTo>
</AssignMessage>

Contoh ini menyalin "h1", "h2", dan nilai kedua "h3". Jika "h3" hanya memiliki satu nilai, maka nilai tersebut tidak disalin.

`<Path>` (anak dari `<Copy>`)

Menentukan apakah jalur harus disalin dari permintaan sumber ke permintaan tujuan. Elemen ini tidak memengaruhi respons.

Jika "true", kebijakan ini menyalin jalur dari pesan permintaan yang ditentukan oleh atribut source elemen <Copy> ke pesan permintaan yang ditentukan oleh elemen <AssignTo>.

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

Elemen <Path> menggunakan sintaksis berikut:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Copy source="[request|response]">
    <Path>[false|true]</Path>
  </Copy>
</AssignMessage>

Contoh 1

Contoh berikut menunjukkan bahwa kebijakan AssignMessage harus menyalin jalur dari permintaan sumber ke objek permintaan kustom yang baru:

<AssignMessage name="copy-path-1">
  <Copy source="request">
    <Path>true</Path>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request">MyCustomRequest</AssignTo>
</AssignMessage>

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

Jenis pesan: Permintaan

`<Payload>` (anak dari `<Copy>`)

Menentukan apakah payload harus disalin dari sumber ke tujuan. Sumber dan tujuan dapat berupa permintaan atau respons.

Jika "true", kebijakan ini akan menyalin payload dari pesan yang ditentukan oleh atribut source elemen <Copy> ke pesan yang ditentukan oleh elemen <AssignTo>.

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

Elemen <Payload> menggunakan sintaksis berikut:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Copy source="[request|response]">
    <Payload>[false|true]</Payload>
  </Copy>
</AssignMessage>

Contoh 1

Contoh berikut menetapkan <Payload> ke "true" sehingga payload permintaan disalin dari permintaan ke respons:

<AssignMessage name="copy-payload-1">
  <Copy source="request">
    <Payload>true</Payload>
  </Copy>
  <AssignTo createNew="true" transport="http" type="response"/>
</AssignMessage>

`<QueryParams>` (anak dari `<Copy>`)

Menyalin parameter string kueri dari permintaan yang ditentukan oleh atribut source elemen <Copy> ke permintaan yang ditentukan oleh elemen <AssignTo>. Elemen ini tidak memengaruhi respons.

Nilai Default	t/a
Wajib?	Opsional
Jenis	Array elemen `<QueryParam>` atau array kosong
Elemen Induk	`<QueryParam>`
Elemen Turunan	Tidak ada

Elemen <QueryParams> menggunakan sintaksis berikut:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Copy source="[request|response]">
    <!-- Can also be an empty array (<QueryParams/>) -->
    <QueryParams>
      <QueryParam name="queryparam_name">queryparam_value</QueryParam>
      ...
    </QueryParams>
  </Copy>
</AssignMessage>

Contoh 1

Contoh berikut menyalin parameter kueri "my_param" dari permintaan ke dalam objek permintaan kustom baru:

<AssignMessage name="copy-queryparams-1">
  <Copy source="request">
    <QueryParams>
      <QueryParam name="my_param"/>
    </QueryParams>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request">MyCustomRequest</AssignTo>
</AssignMessage>

Contoh 2

Contoh berikut menyalin semua parameter kueri dari permintaan ke dalam objek permintaan kustom baru:

<AssignMessage name="copy-queryparams-2">
  <Copy source="request">
    <QueryParams/>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request">MyCustomRequest</AssignTo>
</AssignMessage>

Contoh 3

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

<AssignMessage name="copy-queryparams-3">
  <Copy source="request">
    <QueryParams>
      <QueryParam name="qp1"/>
      <QueryParam name="qp2"/>
      <QueryParam name="qp3.2"/>
    </QueryParams>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request">MyCustomRequest</AssignTo>
</AssignMessage>

Contoh ini menyalin "qp1", "qp2", dan nilai kedua "qp3". Jika "qp3" hanya memiliki satu nilai, maka nilai tersebut tidak disalin.

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

Kata kerja HTTP: GET
Jenis pesan: Permintaan

`<ReasonPhrase>` (anak dari `<Copy>`)

Menentukan apakah frasa alasan harus disalin dari respons sumber ke respons tujuan. Elemen ini tidak berpengaruh pada permintaan.

Jika "true", kebijakan ini akan menyalin ReasonPhrase dari respons yang ditentukan oleh atribut source elemen <Copy> ke respons yang ditentukan oleh elemen <AssignTo>.

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

Elemen <ReasonPhrase> menggunakan sintaksis berikut:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Copy source="[request|response]">
    <ReasonPhrase>[false|true]</ReasonPhrase>
  </Copy>
</AssignMessage>

Contoh 1

Contoh berikut menyetel <ReasonPhrase> ke "true", yang menyebabkan <Copy> menyalin frasa alasan dari respons default ke objek respons kustom:

<AssignMessage name="copy-reasonphrase-1">
  <Copy source="response">
    <ReasonPhrase>true</ReasonPhrase>
  </Copy>
  <AssignTo createNew="trie" transport="http" type="response">MyCustomResponse</AssignTo>
</AssignMessage>

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

Jenis pesan: Respons

`<StatusCode>` (anak dari `<Copy>`)

Menentukan apakah kode status disalin dari respons sumber ke respons tujuan. Elemen ini tidak berpengaruh pada permintaan.

Jika "true", kebijakan ini menyalin kode status dari pesan respons yang ditentukan oleh atribut source elemen <Copy> ke pesan respons yang ditentukan oleh elemen <AssignTo>.

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

Elemen <StatusCode> menggunakan sintaksis berikut:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Copy source="[request|response]">
    <StatusCode>[false|true]</StatusCode>
  </Copy>
</AssignMessage>

Contoh 1

Contoh berikut menetapkan <StatusCode> ke "true", yang menyalin kode status dari objek respons default ke objek respons kustom yang baru:

<AssignMessage name="copy-statuscode-1">
  <Copy source="response">
    <StatusCode>true</StatusCode>
  </Copy>
  <AssignTo createNew="true" transport="http" type="response">MyCustomResponse</AssignTo>
</AssignMessage>

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

Jenis pesan: Respons

Penggunaan umum <StatusCode> adalah untuk memastikan bahwa respons proxy memiliki status yang sama dengan respons yang diterima dari target saat atribut createNew <AssignTo> disetel ke "true".

`<Verb>` (anak dari `<Copy>`)

Menentukan apakah kata kerja HTTP disalin dari permintaan sumber ke permintaan tujuan. Elemen ini tidak memengaruhi respons.

Jika "true", menyalin kata kerja yang ditemukan di atribut source elemen <Copy> ke permintaan yang ditentukan dalam elemen <AssignTo>.

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

Elemen <Verb> menggunakan sintaksis berikut:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Copy source="[request|response]">
    <Verb>[false|true]</Verb>
  </Copy>
</AssignMessage>

Contoh 1

Contoh berikut menetapkan <Verb> ke "true", yang menyalin kata kerja dari permintaan default ke permintaan kustom baru:

<AssignMessage name="copy-verb-1">
  <Copy source="request">
    <Verb>true</Verb>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request">MyCustomRequest</AssignTo>
</AssignMessage>

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

Jenis pesan: Permintaan

`<Version>` (anak dari `<Copy>`)

Menentukan apakah versi HTTP disalin dari permintaan sumber ke permintaan tujuan. Elemen ini tidak memengaruhi respons.

Jika "true", menyalin versi HTTP yang ditemukan di atribut source elemen <Copy> ke objek yang ditentukan oleh elemen <AssignTo>.

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

Elemen <Version> menggunakan sintaksis berikut:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Copy source="[request|response]">
    <Version>[false|true]</Version>
  </Copy>
</AssignMessage>

Contoh 1

Contoh berikut menetapkan <Version> ke "true" pada permintaan, yang menyalin versi dari objek permintaan default ke objek permintaan kustom baru:

<AssignMessage name="copy-version-1">
  <Copy source="request">
    <Version>true</Version>
  </Copy>
  <AssignTo createNew="true" transport="http" type="request">MyCustomRequest</AssignTo>
</AssignMessage>

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

Jenis pesan: Permintaan

`<DisplayName>`

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

Elemen <DisplayName> 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 diselesaikan ditemukan.

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

Setel ke true untuk mengabaikan variabel yang belum diselesaikan dan melanjutkan pemrosesan; jika tidak false. Nilai defaultnya adalah false.

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

Elemen <IgnoreUnresolvedVariables> menggunakan sintaksis berikut:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <IgnoreUnresolvedVariables>[true|false]</IgnoreUnresolvedVariables>
</AssignMessage>

Contoh 1

Contoh berikut menetapkan <IgnoreUnresolvedVariables> ke "true":

<AssignMessage name="ignoreunresolvedvariables">
  <Copy source="response">
    ...
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  </Copy>
</AssignMessage>

`<Remove>`

Menghapus header, parameter kueri, parameter formulir, dan/atau payload pesan dari pesan. Pesan dapat berupa permintaan atau respons. Anda menentukan pesan yang ditindaklanjuti oleh <Remove> dengan menggunakan elemen <AssignTo>.

Nilai Default	t/a
Wajib?	Opsional
Jenis	Jenis kompleks
Elemen Induk	`<AssignMessage>`
Elemen Turunan	`<FormParams>` `<Headers>` `<Payload>` `<QueryParams>`

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

Elemen <Remove> menggunakan sintaksis berikut:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Remove>
    <!-- Can also be an empty array (<FormParams/>) -->
    <FormParams>
      <FormParam name="formparam_name">formparam_value</FormParam>
      ...
    </FormParams>
    <!-- Can also be an empty array (<Headers/>) -->
    <Headers>
      <Header name="header_name">header_value</Header>
      ...
    </Headers>
    <Payload>[false|true]</Payload>
    <!-- Can also be an empty array (<QueryParams/>) -->
    <QueryParams>
      <QueryParam name="queryparam_name">queryparam_value</QueryParam>
      ...
    </QueryParams>
  </Remove>
</AssignMessage>

Contoh 1

Contoh berikut menghapus isi pesan dari respons:

<AssignMessage continueOnError="false" enabled="true" name="remove-1">
  <DisplayName>remove-1</DisplayName>
  <Remove>
    <Payload>true</Payload>
  </Remove>
  <AssignTo createNew="false" transport="http" type="response"/>
</AssignMessage>

Dalam alur respons, kebijakan ini menghapus isi respons, hanya menampilkan header HTTP ke klien.

Contoh 2

Contoh berikut menghapus semua parameter formulir dan parameter kueri dari permintaan yang masuk:

<AssignMessage continueOnError="false" enabled="true" name="remove-2">
  <Remove>
    <!-- Empty (<FormParams/>) removes all form parameters -->
    <FormParams/>
    <QueryParams>
      <QueryParam name="qp1"/>
    </QueryParams>
  </Remove>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

`<FormParams>` (anak 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:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Remove>
    <!-- Can also be an empty array (<FormParams/>) -->
    <FormParams>
      <FormParam name="formparam_name">formparam_value</FormParam>
      ...
    </FormParams>
  </Remove>
</AssignMessage>

Contoh 1

Contoh berikut menghapus tiga parameter formulir dari permintaan:

<AssignMessage name="remove-formparams-1">
  <Remove>
    <FormParams>
      <FormParam name="form_param_1"/>
      <FormParam name="form_param_2"/>
      <FormParam name="form_param_3"/>
    </FormParams>
  </Remove>
  <AssignTo createNew="false" transport="http" type="application/x-www-form-urlencoded"/>
</AssignMessage>

Contoh 2

Contoh berikut menghapus semua parameter formulir dari permintaan:

<AssignMessage name="remove-formparams-2">
  <Remove>
    <FormParams/>
  </Remove>
  <AssignTo createNew="false" transport="http" type="application/x-www-form-urlencoded"/>
</AssignMessage>

Contoh 3

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

<AssignMessage name="remove-formparams-3">
  <Remove>
    <FormParams>
      <FormParam name="f1"/>
      <FormParam name="f2"/>
      <FormParam name="f3.2"/>
    </FormParams>
  </Remove>
  <AssignTo createNew="false" transport="http" type="application/x-www-form-urlencoded"/>
</AssignMessage>

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

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

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

`<Headers>` (anak 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:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Remove>
    <!-- Can also be an empty array (<Headers/>) -->
    <Headers>
      <Header name="header_name">header_value</Header>
      ...
    </Headers>
  </Remove>
</AssignMessage>

Contoh 1

Contoh berikut menghapus header user-agent dari permintaan:

<AssignMessage name="remove-headers-1">
  <Remove>
    <Headers>
      <Header name="user-agent"/>
    </Headers>
  </Remove>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

Contoh 2

Contoh berikut menghapus semua header dari permintaan:

<AssignMessage name="remove-headers-2">
  <Remove>
    <Headers/>
  </Remove>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

Contoh 3

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

<AssignMessage name="remove-headers-3">
  <Remove>
    <Headers>
      <Header name="h1"/>
      <Header name="h2"/>
      <Header name="h3.2"/>
    </Headers>
  </Remove>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

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

`<Payload>` (anak dari `<Remove>`)

Menentukan apakah <Remove> menghapus payload dalam permintaan atau respons, yang ditentukan oleh elemen <AssignTo>. Tetapkan ke "true" untuk menghapus payload; jika tidak, "false". Nilai defaultnya adalah "false".

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

Elemen <Payload> menggunakan sintaksis berikut:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Remove>
    <Payload>[false|true]</Payload>
  </Remove>
</AssignMessage>

Contoh 1

Contoh berikut menyetel <Payload> ke "true" sehingga payload permintaan dihapus:

<AssignMessage name="remove-payload-1">
  <Remove>
    <Payload>true</Payload>
  </Remove>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

`<QueryParams>` (anak 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:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Remove>
    <!-- Can also be an empty array (<QueryParams/>) -->
    <QueryParams>
      <QueryParam name="queryparam_name">queryparam_value</QueryParam>
      ...
    </QueryParams>
  </Remove>
</AssignMessage>

Contoh 1

Contoh berikut menghapus satu parameter kueri dari permintaan:

<AssignMessage name="remove-queryparams-1">
  <Remove>
      <QueryParams>
        <QueryParam name="qp1"/>
      </QueryParams>
  </Remove>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

Contoh 2

Contoh berikut menghapus semua parameter kueri dari permintaan:

<AssignMessage name="remove-queryparams-2">
  <Remove>
      <QueryParams/>
  </Remove>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

Contoh 3

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

<AssignMessage name="remove-queryparams-3">
  <Remove>
      <QueryParams>
        <QueryParam name="qp1"/>
        <QueryParam name="qp2"/>
        <QueryParam name="qp3.2"/>
      </QueryParams>
  </Remove>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

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

Contoh 4

Contoh berikut menghapus parameter kueri apikey dari permintaan:

<AssignMessage name="remove-query-param">
  <Remove>
    <QueryParams>
      <QueryParam name="apikey"/>
    </QueryParams>
  </Remove>
  <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

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

Kata kerja HTTP: GET
Jenis pesan: Permintaan

`<Set>`

Menetapkan informasi dalam pesan permintaan atau respons, yang ditentukan oleh elemen <AssignTo>. <Set> menggantikan header atau parameter yang sudah ada dalam pesan asli. Untuk membuat header atau parameter baru, gunakan elemen <Add>.

Nilai Default	t/a
Wajib?	Opsional
Jenis	Jenis kompleks
Elemen Induk	`<AssignMessage>`
Elemen Turunan	`<FormParams>` `<Headers>` `<Payload>` `<Path>` `<QueryParams>` `<ReasonPhrase>` `<StatusCode>` `<Verb>` `<Version>`

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

Elemen <Set> menggunakan sintaksis berikut:

Sintaksis

<AssignMessage
    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>
    <Payload contentType="content_type" variablePrefix="prefix"
        variableSuffix="suffix">new_payload</Payload>
    <QueryParams>
      <QueryParam name="queryparam_name">queryparam_value</QueryParam>
      ...
    </QueryParams>
    <ReasonPhrase>reason_for_error or {variable}</ReasonPhrase>
    <StatusCode>HTTP_status_code or {variable}</StatusCode>
    <Verb>[GET|POST|PUT|PATCH|DELETE|{variable}]</Verb>
    <Version>[1.0|1.1|{variable}]</Verb>
  </Set>
</AssignMessage>

Contoh 1

Contoh berikut menunjukkan elemen <Set>:

<AssignMessage continueOnError="false" enabled="true" name="set-1">
  <Set>
    <FormParams>
      <FormParam name="myparam">{request.header.myparam}</FormParam>
    </FormParams>
    <Headers>
        <Header name="user-agent">{request.header.user-agent}</Header>
    </Headers>
    <QueryParams>
      <QueryParam name="name">{request.header.name}</QueryParam>
      <QueryParam name="address">{request.header.address}</QueryParam>
    </QueryParams>
    <!-- <Verb>GET</Verb> -->
    <Payload contentType="text/plain">42</Payload>
    <Path/>
    <ReasonPhrase>Bad request</ReasonPhrase>
    <StatusCode>400</StatusCode>
    <Verb>POST</Verb>
    <Verb>{my_variable}</Verb>
    <Version>1.1</Version>
  </Set>
  <AssignTo createNew="false" transport="http" type="response"/>
</AssignMessage>

`<FormParams>` (anak dari `<Set>`)

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

Nilai Default	t/a
Wajib?	Opsional
Jenis	Array elemen `<FormParam>`
Elemen Induk	`<Set>`
Elemen Turunan	`<FormParam>`

Elemen <FormParams> menggunakan sintaksis berikut:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Set>
    <FormParams>
      <FormParam name="formparam_name">formparam_value</FormParam>
      ...
    </FormParams>
  </Set>
</AssignMessage>

Contoh 1

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

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

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

Kata kerja 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 mengirimkannya ke endpoint target.

`<Headers>` (anak dari `<Set>`)

Menimpa 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:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Set>
    <Headers>
      <Header name="header_name">header_value</Header>
      ...
    </Headers>
  </Set>
</AssignMessage>

Contoh 1

Contoh berikut menetapkan header user-agent ke nilai variabel request.header.user-agent:

<AssignMessage name="set-headers-1">
  <Set>
    <Headers>
      <Header name="user-agent">{request.header.user-agent}</Header>
    </Headers>
  </Set>
  <AssignTo createNew="true" transport="http" type="response"/>
</AssignMessage>

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

`<Path>` (anak dari `<Set>`)

Catatan:

Saat ini, elemen ini tidak berfungsi seperti yang dirancang untuk mengganti/menulis ulang URL target proxy. (Ini berfungsi untuk menyetel jalur di Info Layanan, seperti yang ditunjukkan dalam contoh Belajar dengan Melakukan di bawah.)

Terkadang Anda mungkin perlu mengirim pesan ke URL selain URL yang ditentukan di TargetEndpoint proxy API. Jika Anda ingin menulis ulang URL target, ganti variabel target.url di TargetEndpoint menggunakan elemen <AssignVariable>. (Anda tidak dapat mengganti target.url di ProxyEndpoint, karena Edge menetapkan variabel di TargetEndpoint).

Contoh berikut menunjukkan cara kebijakan AssignMessage menggantikan target.url. Sekali lagi, tambahkan kebijakan ke permintaan TargetEndpoint. Dengan kebijakan ini, proxy akan memanggil URL di bawah dan bukan URL yang ditentukan di TargetEndpoint.

<AssignMessage name="Assign-Message-1">
...
  <AssignVariable>
    <Name>target.url</Name>
    <Value>http://mocktarget.apigee.net/user?user=Dude</Value>
  </AssignVariable>
...

Anda juga dapat menggunakan kebijakan JavaScript di TargetEndpoint untuk mengganti target.url.

`<Payload>` (anak dari `<Set>`)

Mendefinisikan isi pesan untuk permintaan atau respons, yang ditentukan oleh elemen <AssignTo>. Payload dapat berupa jenis konten yang valid, seperti teks biasa, JSON, atau XML.

Nilai Default	string kosong
Wajib?	Opsional
Jenis	String
Elemen Induk	`<Set>`
Elemen Turunan	Tidak ada

Elemen <Payload> menggunakan sintaksis berikut:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Set>
    <Payload contentType="content_type" variablePrefix="prefix"
        variableSuffix="suffix">new_payload</Payload>
  </Set>
</AssignMessage>

Contoh 1

Contoh berikut menetapkan payload teks biasa:

<AssignMessage name="set-payload-1">
  <Set>
    <Payload contentType="text/plain">42</Payload>
  </Set>
</AssignMessage>

Contoh 2

Contoh berikut menetapkan payload JSON:

<AssignMessage name="set-payload-2">
  <Set>
    <Payload contentType="application/json">
      {"name":"foo", "type":"bar"}
    </Payload>
  </Set>
</AssignMessage>

Contoh 3

Contoh berikut menyisipkan nilai variabel ke dalam payload dengan mengapit nama variabel dalam tanda kurung kurawal:

<AssignMessage name="set-payload-3">
  <Set>
    <Payload contentType="application/json">
      {"name":"foo", "type":"{variable_name}"}
    </Payload>
  </Set>
</AssignMessage>

Di Apigee Edge versi lama—misalnya, sebelum rilis cloud 16.08.17—Anda tidak dapat menggunakan kurung kurawal untuk menunjukkan referensi variabel dalam payload JSON. Dalam rilis tersebut, Anda harus menggunakan atribut variablePrefix dan variableSuffix untuk menentukan karakter pemisah, dan menggunakannya untuk membungkus nama variabel, seperti berikut:

<AssignMessage name="set-payload-3b">
  <Set>
    <Payload contentType="application/json" variablePrefix="@" variableSuffix="#">
      {"name":"foo", "type":"@variable_name#"}
    </Payload>
  </Set>
</AssignMessage>

Sintaksis lama ini masih berfungsi.

Contoh 4

Konten <Payload> dianggap sebagai template pesan. Artinya, kebijakan AssignMessage mengganti variabel yang diapit tanda kurung kurawal dengan nilai variabel yang dirujuk saat runtime.

Contoh berikut menggunakan sintaksis tanda kurung kurawal untuk menyetel bagian payload ke nilai variabel:

<AssignMessage name="set-payload-4">
  <Set>
    <Payload contentType="text/xml">
      <root>
        <e1>sunday</e1>
        <e2>funday</e2>
        <e3>{var1}</e3>
      </root>
    </Payload>
  </Set>
</AssignMessage>

Tabel berikut menjelaskan atribut <Payload>:

Atribut	Deskripsi	Ketersediaan	Jenis
`contentType`	Jika ditentukan, nilai `contentType` akan ditetapkan ke header HTTP `Content-Type`.	Opsional	String
`variablePrefix`	Secara opsional menentukan pemisah awal pada variabel alur. Nilai defaultnya adalah "{". Untuk informasi selengkapnya, lihat Referensi variabel alur.	Opsional	Char
`variableSuffix`	Secara opsional menentukan pembatas akhir pada variabel alur. Nilai defaultnya adalah "}". Untuk informasi selengkapnya, lihat Referensi variabel alur.	Opsional	Char

`<QueryParams>` (anak dari `<Set>`)

Menimpa parameter kueri yang ada dalam permintaan dengan nilai baru. Elemen ini tidak berpengaruh pada respons.

Nilai Default	t/a
Wajib?	Opsional
Jenis	Array elemen `<QueryParam>`
Elemen Induk	`<Set>`
Elemen Turunan	`<QueryParam>`

Elemen <QueryParams> menggunakan sintaksis berikut:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Set>
    <QueryParams>
      <QueryParam name="queryparam_name">queryparam_value</QueryParam>
      ...
    </QueryParams>
  </Set>
</AssignMessage>

Contoh 1

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

<AssignMessage continueOnError="false" enabled="true" name="set-queryparams-1">
  <Set>
    <QueryParams>
      <QueryParam name="address">{request.header.address}</QueryParam>
    </QueryParams>
  </Set>
</AssignMessage>

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

Kata kerja HTTP: GET
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 menghilangkan <QueryParams>.

`<ReasonPhrase>` (anak dari `<Set>`)

Menetapkan frasa alasan pada respons. Hal ini biasanya dilakukan untuk proses debug bersama dengan <StatusCode>. Elemen ini tidak berpengaruh pada permintaan.

Nilai Default	t/a
Wajib?	Opsional
Jenis	String
Elemen Induk	`<Set>`
Elemen Turunan	Tidak ada

Elemen <ReasonPhrase> menggunakan sintaksis berikut:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Set>
    <ReasonPhrase>reason_for_error or {variable}</ReasonPhrase>
  </Set>
</AssignMessage>

Contoh 1

Contoh berikut menentukan frasa alasan sederhana:

<AssignMessage name="set-reasonphrase-1">
  <Set>
    <ReasonPhrase>Bad medicine</ReasonPhrase>
  </Set>
  <AssignTo createNew="true" transport="http" type="response"/>
</AssignMessage>

Contoh 2

Konten <ReasonPhrase> dianggap sebagai template pesan. Artinya, nama variabel yang diapit kurung kurawal akan diganti saat runtime dengan nilai variabel yang dirujuk, seperti yang ditunjukkan contoh berikut:

<AssignMessage name="set-reasonphrase-2">
  <Set>
    <ReasonPhrase>{calloutresponse.reason.phrase}</ReasonPhrase>
  </Set>
  <AssignTo createNew="true" transport="http" type="response"/>
</AssignMessage>

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

Jenis pesan: Respons

`<StatusCode>` (anak 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:

Sintaksis

<AssignMessage
    continueOnError="[false|true]"
    enabled="[true|false]"
    name="policy_name" >
  <Set>
    <StatusCode>HTTP_status_code or {variable}</StatusCode>
  </Set>
</AssignMessage>

Contoh 1

Contoh berikut menetapkan kode status sederhana:

<AssignMessage name="set-statuscode-1">
  <Set>
    <StatusCode>404</StatusCode>
  </Set>
  <AssignTo createNew="true" transport="http" type="response"/>
</AssignMessage>

Contoh 2

Konten <StatusCode> dianggap sebagai template pesan. Artinya, nama variabel yang diapit kurung kurawal akan diganti saat runtime dengan nilai variabel yang dirujuk, seperti yang ditunjukkan contoh berikut:

<AssignMessage name="set-statuscode-2">
  <Set>
    <StatusCode>{calloutresponse.status.code}</StatusCode>
  </Set>
  <AssignTo createNew="true" transport="http" type="response"/>
</AssignMessage>

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

Jenis pesan: Respons

`<Verb>` (anak dari `<Set>`)

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

Nilai Default	t/a
Wajib?	Opsional
Jenis	String atau `variable`
Elemen Induk	`<Set>`
Elemen Turunan	Tidak ada

Elemen <Verb> menggunakan sintaksis berikut:

Sintaksis

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

Contoh 1

Contoh berikut menetapkan kata kerja sederhana pada permintaan:

<AssignMessage name="set-verb-1">
  <Set>
    <Verb>POST</Verb>
  </Set>
  <AssignTo createNew="true" transport="http" type="request"/>
</AssignMessage>

Contoh 2

Konten <Verb> dianggap sebagai template pesan. Artinya, nama variabel yang diapit kurung kurawal akan diganti saat runtime dengan nilai variabel yang dirujuk.

Contoh berikut menggunakan variabel untuk mengisi kata kerja:

<AssignMessage name="set-verb-2">
  <Set>
    <Verb>{my_variable}</Verb>
  </Set>
  <AssignTo createNew="true" transport="http" type="request"/>
</AssignMessage>

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

Jenis pesan: Permintaan

`<Version>` (anak dari `<Set>`)

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

Nilai Default	t/a
Wajib?	Opsional
Jenis	String atau `variable`
Elemen Induk	`<Set>`
Elemen Turunan	Tidak ada

Elemen <Version> menggunakan sintaksis berikut:

Sintaksis

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

Contoh 1

Contoh berikut menetapkan nomor versi ke "1.1":

<AssignMessage name="set-version-1">
  <Set>
    <Version>1.1</Version>
  </Set>
  <AssignTo createNew="true" transport="http" type="request"/>
</AssignMessage>

Contoh 2

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

<AssignMessage name="set-version-2">
  <Set>
    <Version>{my_version}</Version>
  </Set>
  <AssignTo createNew="true" transport="http" type="request"/>
</AssignMessage>

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

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

Jenis pesan: Permintaan

Membuat pesan permintaan kustom

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

Mengakses variabelnya dalam kebijakan lain
Meneruskannya ke layanan eksternal

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

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

Secara default, Edge tidak melakukan apa pun dengan pesan permintaan kustom. Setelah membuatnya, Edge akan melanjutkan alur dengan permintaan asli. Untuk menggunakan permintaan kustom, tambahkan kebijakan seperti kebijakan ServiceCallout ke proxy Anda yang dapat meneruskan permintaan kustom ke layanan eksternal.

Contoh berikut membuat pesan permintaan kustom:

Contoh 1

Contoh berikut membuat objek permintaan kustom dengan Assign Message:

<AssignMessage name="AssignMessage-3">
  <AssignTo createNew="true" type="request">MyCustomRequest</AssignTo>
  <Copy>
    <Headers>
     <Header name="user-agent"/>
    </Headers>
  </Copy>
  <Set>
    <QueryParams>
      <QueryParam name="address">{request.queryparam.addy}</QueryParam>
    </QueryParams>
    <Verb>GET</Verb>
  </Set>
  <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
</AssignMessage>

Contoh ini:

Membuat objek pesan permintaan baru yang disebut "MyCustomRequest".
Di MyCustomRequest, kebijakan ini:
- Menyalin nilai header HTTP user-agent dari permintaan masuk ke pesan baru. Karena <Copy> menggunakan referensi absolut ke variabel alur user-agent, tidak ada perlu menentukan atribut source ke <Copy>.
- 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 coba ditambahkan oleh kebijakan tidak ada, Edge akan berhenti memproses alur API.

Contoh 2

Berikut contoh lain yang menunjukkan cara membuat objek permintaan kustom dengan Assign Message:

<AssignMessage name="AssignMessage-2">
  <AssignTo createNew="true" type="request">partner.request</AssignTo>
  <Set>
    <Verb>POST</Verb>
    <Payload contentType="text/xml">
      <request><operation>105</operation></request>
    </Payload>
  </Set>
</AssignMessage>

Contoh ini membuat permintaan kustom baru bernama "partner.request". Kemudian, <Verb> dan <Payload> akan ditetapkan pada permintaan baru.

Anda dapat mengakses pesan permintaan kustom dalam kebijakan AssignMessage lain yang terjadi kemudian dalam alur. Contoh berikut mengambil nilai header user-agent pesan permintaan kustom:

<AssignMessage name="custom-request-1-access">
  <DisplayName>custom-request-1-access</DisplayName>
  <AssignTo createNew="false" type="request"></AssignTo>
  <Set>
    <Headers>
      <Header name="user-agentCopyCustomRequest">{MyCustomRequest.header.user-agent}</Header>
    </Headers>
  </Set>
</AssignMessage>

Video

Tonton video berikut untuk mempelajari lebih lanjut kebijakan AssignMessage.

Video	Deskripsi
Mengapa Kebijakan Pesan Ditetapkan?	Pelajari manfaat penggunaan kebijakan AssignMessage untuk mengubah permintaan atau respons API tanpa mengubah kode backend.
Menyalin elemen API menggunakan kebijakan AssignMessage	Menyalin elemen dari permintaan atau respons API dan membuat objek permintaan atau respons baru menggunakan kebijakan AssignMessage.
Menghapus elemen API menggunakan kebijakan AssignMessage	Hapus elemen API dan ubah API sebelum mencapai backend target menggunakan kebijakan AssignMessage.
Menambahkan dan menetapkan elemen API menggunakan kebijakan AssignMessage	Ubah permintaan atau respons API dengan menambahkan parameter kueri, header, parameter formulir, atau payload menggunakan kebijakan AssignMessage.
Membuat variabel kustom menggunakan kebijakan AssignMessage	Tetapkan variabel alur kustom menggunakan kebijakan AssignMessage dan manfaatkan variabel tersebut dalam kebijakan lain di proxy API.
Buat objek permintaan atau respons baru menggunakan kebijakan AssignMessage	Buat objek permintaan atau respons API baru menggunakan kebijakan AssignMessage saat runtime API.
Membuat API tiruan menggunakan kebijakan AssignMessage	Buat REST API tiruan sederhana dengan menambahkan kebijakan AssignMessage dalam alur respons.
Menetapkan atau mengubah payload menggunakan kebijakan AssignMessage	Mengonversi permintaan REST menjadi permintaan SOAP dengan menetapkan Payload SOAP menggunakan kebijakan AssignMessage saat runtime API.

Kode error

Bagian ini menjelaskan kode kesalahan dan pesan kesalahan yang dikembalikan dan variabel kesalahan yang disetel oleh Edge saat kebijakan ini memicu kesalahan. 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 Penanganan kesalahan.

Error runtime

Error ini dapat terjadi saat kebijakan dijalankan.

Kode error Status HTTP Penyebab Perbaiki

steps.assignmessage.SetVariableFailed 500 Kebijakan tidak dapat menyetel variabel. Lihat string fault untuk mengetahui nama variabel yang belum terselesaikan.

Kode error	Status HTTP	Penyebab
`steps.assignmessage.SetVariableFailed`	500	Kebijakan tidak dapat menyetel variabel. Lihat string fault untuk mengetahui nama variabel yang belum terselesaikan.
`steps.assignmessage.VariableOfNonMsgType`	500	Error ini terjadi jika atribut `source` dalam elemen `<Copy>` disetel ke variabel yang bukan merupakan jenis message. Variabel jenis pesan mewakili seluruh permintaan dan respons HTTP. Edge bawaan variabel alur `request`, `response`, dan `message` adalah jenis pesan. Untuk mempelajari lebih lanjut tentang variabel pesan, lihat Referensi variabel.
`steps.assignmessage.UnresolvedVariable`	500	Error ini terjadi jika variabel yang ditentukan dalam kebijakan Tetapkan Pesan: di luar cakupan (tidak tersedia di alur tertentu tempat kebijakan dijalankan) atau tidak dapat diselesaikan (tidak ditentukan)

steps.assignmessage.VariableOfNonMsgType

500

Error ini terjadi jika atribut source dalam elemen <Copy> disetel ke variabel yang bukan merupakan jenis message.

Variabel jenis pesan mewakili seluruh permintaan dan respons HTTP. Edge bawaan variabel alur request, response, dan message adalah jenis pesan. Untuk mempelajari lebih lanjut tentang variabel pesan, lihat Referensi variabel.

steps.assignmessage.UnresolvedVariable

500

Error ini terjadi jika variabel yang ditentukan dalam kebijakan Tetapkan Pesan:

di luar cakupan (tidak tersedia di alur tertentu tempat kebijakan dijalankan)
tidak dapat diselesaikan (tidak ditentukan)

Error saat deployment

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

Nama error	Penyebab	Perbaiki
`InvalidIndex`	Jika indeks ditentukan dalam elemen `<Copy>` dan/atau `<Remove>` dari Tugaskan Pesan kebijakannya adalah 0 atau angka negatif, maka deployment Proxy API akan gagal.
`InvalidVariableName`	Jika elemen turunan `<Name>` kosong atau tidak ditentukan dalam elemen `<AssignVariable>`, deployment proxy API akan gagal karena tidak ada nama variabel valid untuk yang harus diberi nilai. Nama variabel yang valid wajib diisi.
`InvalidPayload`	Payload yang ditentukan dalam kebijakan tidak valid.

Variabel kesalahan

Variabel ini ditetapkan saat kebijakan ini memicu error saat runtime. Untuk informasi selengkapnya, lihat Apa yang yang perlu diketahui 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"`
`assignmessage.policy_name.failed`	`policy_name` adalah nama kebijakan yang ditentukan pengguna yang menampilkan kesalahan.	`assignmessage.AM-SetResponse.failed = true`

Contoh respons error

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

{  
   "fault":{  
      "detail":{  
         "errorcode":"steps.assignmessage.VariableOfNonMsgType"
      },
      "faultstring":"AssignMessage[AM-SetResponse]: value of variable is not of type Message"
   }
}

Contoh aturan kesalahan

<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="Assign Message Faults">
    <Step>
        <Name>AM-CustomNonMessageTypeErrorResponse</Name>
        <Condition>(fault.name Matches "VariableOfNonMsgType") </Condition>
    </Step>
    <Step>
        <Name>AM-CustomSetVariableErrorResponse</Name>
        <Condition>(fault.name = "SetVariableFailed")</Condition>
    </Step>
    <Condition>(assignmessage.failed = true) </Condition>
</FaultRule>

Skema

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

Topik terkait

Contoh kebijakan Working AssignMessage tersedia di contoh Platform API.

Untuk contoh yang lebih canggih tentang cara mengganti target.url dari ProxyEndpoint, lihat artikel Komunitas Apigee ini.

Untuk melihat "set path" yang diterapkan dalam kebijakan ServiceCallout, lihat contoh Learn by doing ini di contoh Apigee GitHub. Cukup clone repositori dan ikuti petunjuk dalam topik tersebut. Contoh ini menggunakan kebijakan AssignMessage untuk menetapkan jalur permintaan, lalu menggunakan kebijakan Panggilan Layanan untuk membuat permintaan ke layanan eksternal.

Kebijakan AssignMessage

Apa

Kasus penggunaan

Elemen <AssignMessage>

Sintaksis

Kebijakan Default

Contoh

1: Tambahkan header

2: Hapus payload

3: Mengubah respons

4: Menetapkan konten dinamis

5: Hapus parameter kueri

6: Menetapkan/mendapatkan variabel

7: Mendapatkan header respons Service Callout

Referensi elemen turunan

<Add>

Sintaksis

Contoh 1

Contoh 2

Contoh 3

<FormParams> (anak dari <Add>)

Sintaksis

Contoh 1

Contoh 2

Contoh 3

<Headers> (anak dari <Add>)

Sintaksis

Contoh 1

<QueryParams> (anak dari <Add>)

Sintaksis

Contoh 1

<AssignTo>

Sintaksis

Contoh 1

Contoh 2

Contoh 3

<AssignVariable>

Sintaksis

Contoh 1

Contoh 2

Contoh 3

<Name> (anak dari <AssignVariable>)

Sintaksis

Contoh 1

<Ref> (anak dari <AssignVariable>)

Sintaksis

Contoh 1

Contoh 2

Contoh 3

<Template> (anak dari <AssignVariable>)

Sintaksis

Contoh 1

Contoh 2

Contoh 3

<Value> (anak dari <AssignVariable>)

Sintaksis

Contoh 1

Contoh 2

<Copy>

Sintaksis

Contoh 1

<FormParams> (anak dari <Copy>)

Sintaksis

Contoh 1

Contoh 2

Contoh 3

Contoh 4

<Headers> (anak dari <Copy>)

Sintaksis

Contoh 1

Contoh 2

Contoh 3

<Path> (anak dari <Copy>)

Sintaksis

Contoh 1

<Payload> (anak dari <Copy>)

Sintaksis

Contoh 1

<QueryParams> (anak dari <Copy>)

Sintaksis

Elemen `<AssignMessage>`

`<Add>`

`<FormParams>` (anak dari `<Add>`)

`<Headers>` (anak dari `<Add>`)

`<QueryParams>` (anak dari `<Add>`)

`<AssignTo>`

`<AssignVariable>`

`<Name>` (anak dari `<AssignVariable>`)

`<Ref>` (anak dari `<AssignVariable>`)

`<Template>` (anak dari `<AssignVariable>`)

`<Value>` (anak dari `<AssignVariable>`)

`<Copy>`

`<FormParams>` (anak dari `<Copy>`)

`<Headers>` (anak dari `<Copy>`)

`<Path>` (anak dari `<Copy>`)

`<Payload>` (anak dari `<Copy>`)

`<QueryParams>` (anak dari `<Copy>`)

`<ReasonPhrase>` (anak dari `<Copy>`)

`<StatusCode>` (anak dari `<Copy>`)

`<Verb>` (anak dari `<Copy>`)

`<Version>` (anak dari `<Copy>`)

`<DisplayName>`

`<IgnoreUnresolvedVariables>`

`<Remove>`

`<FormParams>` (anak dari `<Remove>`)

`<Headers>` (anak dari `<Remove>`)

`<Payload>` (anak dari `<Remove>`)

`<QueryParams>` (anak dari `<Remove>`)

`<Set>`

`<FormParams>` (anak dari `<Set>`)

`<Headers>` (anak dari `<Set>`)

`<Path>` (anak dari `<Set>`)

`<Payload>` (anak dari `<Set>`)

`<QueryParams>` (anak dari `<Set>`)

`<ReasonPhrase>` (anak dari `<Set>`)

`<StatusCode>` (anak dari `<Set>`)