在 API Proxy 中強制實行營利限制

本頁內容適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

本頁說明如何將政策附加至營利 API 產品中的 API Proxy，強制執行營利限制。

新增驗證政策

Apigee 營利功能會使用 VerifyAPIKey 政策或 OAuth2 政策的 VerifyAccessToken 作業，檢查是否有已發布的有效費率方案，判斷傳入的要求是否可營利。

使用 Apigee UI 或 API 將政策附加至 API Proxy。如要瞭解如何編輯 Proxy，請參閱「編輯 API Proxy」。

另請參閱：

對 API 產品強制執行開發人員訂閱

將 MonetizationLimitsCheck 政策附加至 API Proxy，對 API 產品強制執行開發人員訂閱：

  • 如果在 Proxy 呼叫執行期間擷取的 API 產品沒有營利費率方案， 系統會將該產品視為非營利產品，MonetizationLimitsCheck 政策不會擷取任何 進一步的資料，且政策不會生效。
  • 如果系統找到費率方案，但找不到 API 開發人員的訂閱項目，MonetizationLimitsCheck 政策會引發錯誤並封鎖 API 呼叫。

將 MonetizationLimitsCheck 政策附加至 API Proxy 時，系統會填入 mint.limitscheck.* 和 mint.subscription_* 流程變數，如「偵錯 MonetizationLimitsCheck 政策」和 mint 流程變數參照中所述。

如需詳細資訊，請參閱：

在 API Proxy 中強制實行營利配額

配額定義 API 產品在特定時間內允許的要求數。如要強制執行營利配額，建議您在建立 API 產品時設定配額值。

為 API 產品定義配額值，並不會自動對透過 API 產品發出的呼叫次數強制執行限制。您也必須將配額政策新增至 API 產品參照的 API Proxy，確保系統會強制執行 API 產品層級定義的配額值。

編輯配額政策，啟用 <UseQuotaConfigInAPIProduct> 元素，使用在 API 產品層級定義的配額設定。

例如：

<Quota continueOnError="false" enabled="true" name="impose-quota">
    <DisplayName>Impose Quota</DisplayName>
    <UseQuotaConfigInAPIProduct stepName="verify-api-key">
        <DefaultConfig>
            <Allow>10000</Allow>
            <Interval>1</Interval>
            <TimeUnit>week</TimeUnit>
        </DefaultConfig>
    </UseQuotaConfigInAPIProduct>
    <Distributed>true</Distributed>
    <Synchronous>true</Synchronous>
    <StartTime>2021-01-01 12:00:00</StartTime>
</Quota>

將配額政策附加至 API Proxy 時，系統會填入 ratelimit.* 流程變數，如「偵錯配額政策」和配額政策流程變數參考資料所述。

如需詳細資訊，請參閱：