Kebijakan MonetizationLimitsCheck

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat Dokumentasi Apigee Edge.

Ringkasan

Kebijakan MonetizationLimitsCheck memungkinkan Anda menerapkan batas monetisasi.

Secara khusus, kebijakan ini dipicu jika developer aplikasi yang mengakses API yang dimonetisasi belum membeli langganan untuk produk API terkait atau jika developer tidak memiliki saldo yang cukup. Dalam hal ini, kebijakan MonetizationLimitsCheck akan melaporkan kesalahan dan memblokir panggilan API. Untuk informasi selengkapnya, lihat Menerapkan langganan developer ke produk API.

Saat Anda melampirkan kebijakan MonetizationLimitsCheck ke proxy API, variabel alur mint.limitscheck.* dan mint.subscription_* akan terisi, seperti yang dijelaskan dalam referensi variabel alur mint.

Kebijakan ini merupakan Kebijakan yang dapat diperluas dan penggunaan kebijakan ini mungkin menimbulkan biaya atau implikasi penggunaan, bergantung pada lisensi Apigee Anda. Untuk mengetahui informasi tentang jenis kebijakan dan implikasi penggunaan, lihat Jenis kebijakan.

<MonetizationLimitsCheck>

Menentukan kebijakan MonetizationLimitsCheck.

Tabel berikut memberikan deskripsi tingkat tinggi untuk elemen turunan <MonetizationLimitsCheck>:

Elemen <MonetizationLimitsCheck> menggunakan sintaksis berikut:

<?xml version="1.0" encoding="UTF-8" standalone="no"?><MonetizationLimitsCheck continueOnError="[true|false]" enabled="[true|false]" name="policy_name">
   <DisplayName>POLICY_DISPLAY_NAME</DisplayName>
   <FaultResponse>
        <AssignVariable>
          <Name/>
          <Value/>
        </AssignVariable>
        <Add>
            <Headers/>
        </Add>
        <Copy source="request">
            <Headers/>
            <StatusCode/>
       </Copy>
        <Remove>
            <Headers/>
        </Remove>
        <Set>
            <Headers/>
            <Payload/>
            <StatusCode/>
        </Set>
    </FaultResponse>
    <IgnoreUnresolvedVariables>VALUE</IgnoreUnresolvedVariables>
</MonetizationLimitsCheck>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<MonetizationLimitsCheck continueOnError="false" enabled="true" name="MonetizationLimitsCheck-1">
  <DisplayName>Monetization-Limits-Check-1</DisplayName>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <FaultResponse>
    <Set>
      <Payload contentType="text/xml">
        <error>
          <messages>
            <message>Usage has been exceeded ({mint.limitscheck.isRequestBlocked}) or app developer has been suspended</message>
          </messages>
        </error>
      </Payload>
      <StatusCode>403</StatusCode>
    </Set>
  </FaultResponse>
</MonetizationLimitsCheck>

Elemen ini memiliki atribut berikut yang sama untuk semua kebijakan:

Referensi elemen turunan

<DisplayName>

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

Elemen <DisplayName> bersifat umum untuk semua kebijakan.

Elemen <DisplayName> menggunakan sintaksis berikut:

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

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

Elemen <DisplayName> tidak memiliki atribut atau elemen turunan.

<FaultResponse>

Menentukan pesan respons yang ditampilkan ke klien yang meminta. FaultResponse menggunakan setelan yang sama dengan <FaultResponse> dalam kebijakan RaiseFault.

<AssignVariable>

Menetapkan nilai ke variabel alur tujuan. Jika variabel flow tidak ada, AssignVariable akan membuatnya.

Misalnya, gunakan kode berikut untuk menetapkan variabel bernama myFaultVar dalam kebijakan MonetizationLimitsCheck:

<FaultResponse>
<AssignVariable>
  <Name>myFaultVar</Name>
  <Value>42</Value>
</AssignVariable>
</FaultResponse>

Kemudian, kebijakan dalam aturan fault dapat mengakses variabel. Misalnya, kebijakan MenetapkanMessage berikut menggunakan variabel untuk menyetel Header dalam respons fault:

<AssignMessage enabled="true" name="Assign-Message-1">
<Add>
  <Headers>
    <Header name="newvar">{myFaultVar}</Header>
  </Headers>
</Add>
<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
<AssignTo createNew="false" transport="http" type="response"/>
</AssignMessage>

<AssignVariable> dalam kebijakan MonetizationLimitsCheck menggunakan sintaksis yang sama dengan Elemen <AssignVariable> dalam kebijakan MenetapkanMessage.

<Name>

Nama variabel. Untuk informasi selengkapnya, lihat Nama dalam kebijakan MenetapkanMessage.

<Value>

Nilai variabel. Untuk informasi selengkapnya, lihat Nilai dalam kebijakan MenetapkanMessage.

<Add>

Menambahkan header HTTP ke pesan error.

<Headers>

Menentukan header HTTP yang akan ditambahkan, disetel, disalin, atau dihapus.

Contoh:

<Add>
    <Headers>
        <Header name="user-agent">{request.user.agent}</Header>
    </Headers>
</Add>

<Set>
    <Headers>
        <Header name="user-agent">{request.header.user-agent}</Header>
    </Headers>
</Set>

<Copy source='request'>
    <Headers>
        <Header name="headerA"/>
    </Headers>
</Copy>

<Copy source='request'>
    <Headers>
      <Header name="h1"/>
      <Header name="h2"/>
      <Header name="h3.2"/>
    </Headers>
</Copy>

<Remove>
    <Headers>
        <Header name="user-agent"/>
    </Headers>
</Remove>

<Remove>
    <Headers>
      <Header name="h1"/>
      <Header name="h2"/>
      <Header name="h3.2"/>
    </Headers>
</Remove>

<Copy>

Menyalin informasi dari pesan yang ditentukan oleh source ke pesan error.

Tabel berikut menjelaskan atribut <Copy>:

<StatusCode>

Menentukan kode status HTTP dalam pesan error. Anda dapat menyalin atau menetapkan nilai dari untuk objek yang ditentukan oleh atribut source.

Contoh:

<Copy source='response'>
    <StatusCode>404</StatusCode>
</Copy>

<Set source='request'>
    <StatusCode>404</StatusCode>
</Set>

<Remove>

Menghapus header HTTP yang ditentukan dari pesan error. Untuk menghapus semua {i>header<i}, tentukan <Remove><Headers/></Remove>.

<Set>

Menetapkan informasi dalam pesan error.

<Payload>

Menetapkan payload pesan error.

Contoh:

<Set>
    <Payload contentType="text/plain">test1234</Payload>
</Set>

<Set>
    <Payload contentType="application/json">
        {"name":"foo", "type":"bar"}
    </Payload>
</Set>

<Set>
    <Payload contentType="application/json" variablePrefix="@" variableSuffix="#">
        {"name":"foo", "type":"@variable_name#"}
    </Payload>
</Set>

<Set>
    <Payload contentType="application/json">
        {"name":"foo", "type":"{variable_name}"}
    </Payload>
</Set>

<Set>
    <Payload contentType="text/xml">
        <root>
          <e1>sunday</e1>
          <e2>funday</e2>
          <e3>{var1}</e3>
    </Payload>
</Set>

<IgnoreUnresolvedVariables>

Menentukan apakah pemrosesan berhenti saat variabel yang belum terselesaikan ditemukan.

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

Menyetel <IgnoreUnresolvedVariables> ke true berbeda dengan menyetel <MonetizationLimitsCheck> continueOnError hingga true. Jika Anda menetapkan continueOnError ke true, Apigee akan mengabaikan semua error, bukan hanya {i>error <i} dalam variabel.

Elemen <IgnoreUnresolvedVariables> menggunakan sintaksis berikut:

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

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

Kode error

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

Error runtime

Error ini dapat terjadi saat kebijakan dieksekusi.

Variabel kesalahan

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

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

Variabel flow

Variabel alur standar berikut akan otomatis diisi saat kebijakan MonetizationLimitsCheck akan dijalankan. Untuk informasi selengkapnya, lihat variabel alur mint.