Pemecahan masalah error Reset Quota

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

InvalidRLPolicy

Kode error

policies.resetquota.InvalidRLPolicy

Isi respons error

{
    "fault": {
        "faultstring": "Invalid rate limit policy quota_policy_name",
        "detail": {
            "errorcode": "policies.resetquota.InvalidRLPolicy"
        }
    }
}

Contoh pesan error

{
    "fault": {
        "faultstring": "Invalid rate limit policy MyQuotaPolicy",
        "detail": {
            "errorcode": "policies.resetquota.InvalidRLPolicy"
        }
    }
}

Penyebab

Error ini terjadi jika kebijakan Kuota yang ditentukan dalam elemen <Quota> dari kebijakan Reset Kuota tidak ditentukan di proxy API. Elemen <Quota> bersifat wajib dan mengidentifikasi kebijakan Kuota target yang penghitungnya harus diperbarui melalui kebijakan Reset Kuota. Kebijakan Kuota target ini harus dibuat dan ditentukan di dalam proxy API yang sama dan harus tersedia selama alur

Misalnya, elemen <Quota> didefinisikan seperti yang terlihat di bawah ini, tetapi jika MyQuotaPolicy tidak ditentukan dalam Proxy API maka Anda akan mendapatkan error di atas.

<Quota name="MyQuotaPolicy">

Diagnosis

  1. Identifikasi nama kebijakan Kuota yang tidak valid yang ditentukan dalam kebijakan Reset Kuota. Anda dapat menemukan nama kebijakan Kuota dari faultstring. Misalnya, dalam faultstring berikut, nama kebijakan Kuota adalah MyQuotaPolicy:

    "faultstring": "Invalid rate limit policy MyQuotaPolicy"
    
  2. Periksa setiap kebijakan Reset Quota di Proxy API yang kegagalannya yang terjadi. Identifikasi kebijakan Reset Kuota tertentu dengan kebijakan Kuota yang ditentukan dalam elemen wajib <Quota> cocok dengan nama yang diidentifikasi pada Langkah 1 di atas.

    Misalnya, kebijakan Reset Quota berikut menentukan kebijakan Quota bernama MyQuotaPolicy, yang cocok dengan yang ada di faultstring:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <ResetQuota async="false" continueOnError="false" enabled="true" name="Reset_Quota_Demo">
        <DisplayName>Reset_Quota_Demo</DisplayName>
        <Properties/>
        <Quota name="MyQuotaPolicy">
           <Identifier name="identifierName" ref="request.header.identifier">
                <Allow>100</Allow>
            </Identifier>
        </Quota>
    </ResetQuota>
    
    
  3. Tentukan apakah kebijakan Kuota ini dibuat dan ditetapkan dalam proxy API yang sama. Jika tidak ada kebijakan Kuota di proxy API yang sama, itulah penyebabnya error tersebut.

    Pada contoh yang ditampilkan di atas, kebijakan Kuota MyQuotaPolicy seharusnya ada dalam alur sebelum kebijakan Reset Kuota Reset_Quota_Demo dijalankan.

    Karena Kebijakan Kuota MyQuotaPolicy tidak ada dalam alur, Anda akan menerima kode error:

"errorcode": "policies.resetquota.InvalidRLPolicy"

Resolusi

Pastikan Kebijakan Kuota yang dideklarasikan dalam elemen <Quota> ditentukan dalam proxy API. Kebijakan Kuota target ini harus tersedia saat kebijakan Reset Kuota dijalankan.

FailedToResolveAllowCountRef

Kode error

policies.resetquota.FailedToResolveAllowCountRef

Isi respons error

Failed to resolve allow count reference reference_name for identifier identifier_name
in ResetQuotaStepDefinition:policy_name;API Proxy:proxy_name;Revision:
revision_number;Environment:env_name;Organization:org_name

Contoh pesan error

Failed to resolve allow count reference request.header.allowcount for identifier
identifierName in ResetQuotaStepDefinition:ResetQuota;API Proxy:Reset_Quota;
Revision:10;Environment:test;Organization:demo

Error yang ditampilkan ke klien akan berupa: policies.ratelimit.QuotaViolation.

Penyebab

Error ini terjadi jika referensi ke variabel yang berisi jumlah izin di elemen <Allow> kebijakan tidak dapat di-resolve ke nilai. Elemen ini bersifat wajib dan menentukan jumlah untuk mengurangi penghitung kuota.

Diagnosis

  1. Identifikasi kebijakan Reset Quota tempat terjadinya error dan nama variabel referensi yang tidak dapat diselesaikan. Anda dapat menemukan kedua item ini dalam respons error.

    Misalnya, dalam faultstring berikut, nama kebijakannya adalah ResetQuota dan referensinya adalah request.header.allowcount:

    Failed to resolve allow count reference request.header.allowcount for identifier
    identifierName in ResetQuotaStepDefinition:ResetQuota;API Proxy:Reset_Quota;
    Revision:10;Environment:test;Organization:demo
    
  2. Dalam XML kebijakan Reset Quota yang gagal, verifikasi bahwa nama referensinya variabel yang digunakan cocok dengan nama referensi yang diidentifikasi dalam respons error (Langkah 1 di atas).

    Misalnya, kebijakan berikut menetapkan elemen dengan referensi bernama request.header.allowcount, yang cocok dengan yang ada dalam error:

    <ResetQuota async="false" continueOnError="false" enabled="true" name="ResetQuota">
        <DisplayName>ResetQuota</DisplayName>
        <Properties/>
        <Quota name="MyQuotaPolicy">
            <Identifier name="identifierName">
                <Allow ref="request.header.allowcount"/>
            </Identifier>
        </Quota>
    </ResetQuota>
    
  3. Tentukan apakah variabel referensi ditentukan dan tersedia dalam alur tempat kebijakan Reset Kuota dijalankan.

  4. Jika variabelnya adalah:

    1. di luar cakupan (tidak tersedia dalam alur tertentu tempat kebijakan dijalankan) atau
    2. tidak dapat diselesaikan (tidak ditentukan)

    maka itulah penyebab kesalahannya.

    Pada contoh yang ditampilkan di atas, nilai jumlah yang diizinkan di elemen <Allow> seharusnya diambil dari header permintaan bernama allowcount. Namun, Edge tidak dapat me-resolve request.header.allowcount. Hal ini terjadi jika header allowcount tidak diteruskan sebagai bagian dari permintaan API.

    Berikut ini contoh permintaan API yang tidak meneruskan header allowcount sebagai bagian permintaan:

    curl -v http://demo-eval-test.apigee.net/v1/reset_quota -H "Content-Type: application/json"
    

    Karena header allowcount tidak diteruskan sebagai bagian dari permintaan, variabel request.header.allowcount digunakan dalam elemen <Allow> pada Reset di atas Kebijakan kuota tidak ditentukan sehingga tidak dapat diselesaikan. Jadi, Anda akan menerima respons error:

    Failed to resolve allow count reference request.header.allowcount for identifier
    identifierName in ResetQuotaStepDefinition:ResetQuota;API Proxy:Reset_Quota;
    Revision:10;Environment:test;Organization:demo
    

Resolusi

Pastikan variabel yang dirujuk dalam elemen <Allow> ada/ditentukan dan tersedia di alur tertentu, tempat kebijakan Reset Kuota dijalankan.

Untuk memperbaiki contoh yang ditampilkan di atas, Anda dapat mengubah permintaan untuk menyertakan header allowcount seperti yang ditunjukkan di bawah ini:

curl -v http://demo-eval-test.apigee.net/v1/reset_quota -H "Content-Type: application/json" -H "allowcount:30"

FailedToResolveRLPolicy

Kode error

policies.resetquota.FailedToResolveRLPolicy

Isi respons error

{
    "fault": {
        "faultstring": "Failed to resolve rate limit policy",
        "detail": {
            "errorcode": "policies.resetquota.FailedToResolveRLPolicy"
        }
    }
}

Contoh pesan error

{
    "fault": {
        "faultstring": "Failed to resolve rate limit policy",
        "detail": {
            "errorcode": "policies.resetquota.FailedToResolveRLPolicy"
        }
    }
}

Penyebab

Error ini terjadi jika variabel yang dirujuk oleh atribut ref dalam elemen <Quota> tidak dapat di-resolve.

Misalnya, jika atribut ref ditetapkan sebagai request.header.quotapolicy di elemen <Quota>, tetapi tidak tersedia dalam alur proxy API, Anda akan mendapatkan error di atas.

<Quota ref="request.header.quotapolicy">

Diagnosis

  1. Periksa setiap kebijakan Reset Quota di Proxy API yang kegagalannya terjadi dan identifikasi kebijakan Reset Kuota dengan nama referensi variabel yang ditentukan dalam elemen <Quota> tidak dapat diselesaikan dengan benar.

  2. Tentukan apakah variabel ditentukan dan tersedia dalam alur tempat kebijakan Reset Kuota dijalankan.

  3. Jika variabel adalah:

    1. di luar cakupan (tidak tersedia di alur tertentu tempat kebijakan dijalankan) atau
    2. tidak dapat diselesaikan (tidak ditentukan)

    maka itulah penyebab error.

    Pada contoh yang ditampilkan di bawah, nama kebijakan Kuota target seharusnya yang diambil dari header permintaan yang bernama quotapolicy. Namun, Edge tidak dapat menyelesaikan request.header.quotapolicy. Hal ini terjadi jika header quotapolicy tidak diteruskan sebagai bagian dari permintaan API.

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <ResetQuota async="false" continueOnError="false" enabled="true" name="Reset_Quota_Demo">
        <DisplayName>Reset_Quota_Demo</DisplayName>
        <Properties/>
        <Quota ref="request.header.quotapolicy">
            <Identifier name="identifierName" ref="request.header.identifier">
                <Allow>100</Allow>
            </Identifier>
        </Quota>
    </ResetQuota>
    

    Berikut adalah contoh permintaan API yang tidak meneruskan header quotapolicy sebagai bagian dari permintaan:

    curl -v http://demo-eval-test.apigee.net/v1/reset_quota -H "Content-Type: application/json"
    

    Karena header quotapolicy tidak diteruskan sebagai bagian dari permintaan, referensi tersebut request.header.quotapolicy digunakan dalam elemen <Quota> pada Reset di atas Kebijakan kuota tidak ditentukan dan tidak dapat diselesaikan. Hasilnya, Anda menerima respons error:

    "errorcode": "policies.resetquota.FailedToResolveRLPolicy"
    

Resolusi

Pastikan atribut ref yang dirujuk dalam elemen <Quota> di-resolve pada dan tersedia di alur tertentu, tempat kebijakan Reset Kuota dijalankan.

Untuk memperbaiki contoh yang ditampilkan di atas, Anda dapat mengubah permintaan untuk menyertakan header quotapolicy seperti yang ditunjukkan di bawah:

curl -v http://demo-eval-test.apigee.net/v1/reset_quota -H "Content-Type: application/json" -H "quotapolicy:MyQuotaPolicy"