共用方式為


依訂用帳戶設定使用量配額

適用於:所有 APIM 層

quota 原則會以訂用帳戶為單位,強制採用可續訂或有存留期呼叫量與 (或) 頻寬配額。 超過配額時,呼叫者會收到 403 Forbidden 回應狀態碼,而回應會包含 Retry-After 標頭,其值為以秒為單位的建議重試間隔。

若要瞭解速率限制和配額之間的差異,請參閱速率限制和配額

注意

在服務平台中重新啟動基礎計算資源時,APIM 可能會在達到配額後持續處理要求一小段時間。

注意

請依照原則陳述式中提供的順序,來設定原則的元素和子元素。 深入了解如何設定或編輯 APIM 原則

原則陳述式

<quota calls="number" bandwidth="kilobytes" renewal-period="seconds">
    <api name="API name" id="API id" calls="number">
        <operation name="operation name" id="operation id" calls="number" />
    </api>
</quota>

屬性

屬性 描述 是必要欄位 預設
bandwidth renewal-period 中指定的時間週期內允許的 KB 總數上限。 不允許使用原則運算式。 必須指定 callsbandwidth,或同時指定兩者。 N/A
通話 renewal-period 中指定的時間週期內允許的呼叫總數上限。 不允許使用原則運算式。 必須指定 callsbandwidth,或同時指定兩者。 N/A
renewal-period 配額重設之後,固定視窗的長度 (以秒為單位)。 每個期間的開始時間都是相對於訂閱的開始時間來計算。 當 renewal-period 設定為 0 時,期間會設定為無限。 不允許使用原則運算式。 Yes N/A

元素

元素 描述 必要
api 新增一個或多個上述元素,以對產品內的 API 強加呼叫配額。 產品和 API 呼叫配額會獨立套用。 API 可以透過 nameid 參考。 如果同時提供兩個屬性,則會使用 id 而忽略 name No
作業 新增一個或多個上述元素,以對 API 內的作業強加呼叫配額。 產品、API 和作業呼叫配額會獨立套用。 作業可以透過 nameid 參考。 如果同時提供兩個屬性,則會使用 id 而忽略 name No

api 屬性

屬性 描述 是必要欄位 預設
NAME 要套用呼叫配額限制的 API 名稱。 必須指定 nameid 其中之一。 N/A
id 要套用呼叫配額限制的 API 識別碼。 必須指定 nameid 其中之一。 N/A
bandwidth renewal-period 中指定的時間週期內允許的 KB 總數上限。 不允許使用原則運算式。 必須指定 callsbandwidth,或同時指定兩者。 N/A
通話 renewal-period 中指定的時間週期內允許的呼叫總數上限。 不允許使用原則運算式。 必須指定 callsbandwidth,或同時指定兩者。 N/A
renewal-period 配額重設之後,固定視窗的長度 (以秒為單位)。 每個期間的開始時間都是相對於訂閱的開始時間來計算。 當 renewal-period 設定為 0 時,期間會設定為無限。 不允許使用原則運算式。 Yes N/A

作業屬性

屬性 描述 是必要欄位 預設
NAME 要套用呼叫配額限制的作業名稱。 必須指定 nameid 其中之一。 N/A
id 要套用呼叫配額限制的作業識別碼。 必須指定 nameid 其中之一。 N/A
bandwidth renewal-period 中指定的時間週期內允許的 KB 總數上限。 不允許使用原則運算式。 必須指定 callsbandwidth,或同時指定兩者。 N/A
通話 renewal-period 中指定的時間週期內允許的呼叫總數上限。 不允許使用原則運算式。 必須指定 callsbandwidth,或同時指定兩者。 N/A
renewal-period 配額重設之後,固定視窗的長度 (以秒為單位)。 每個期間的開始時間都是相對於訂閱的開始時間來計算。 當 renewal-period 設定為 0 時,期間會設定為無限。 不允許使用原則運算式。 Yes N/A

使用方式

使用注意事項

  • 每份原則定義只能使用此原則一次。
  • 只有在使用訂用帳戶金鑰存取 API 時,才會套用此原則。

範例

<policies>
    <inbound>
        <base />
        <quota calls="10000" bandwidth="40000" renewal-period="3600" />
    </inbound>
    <outbound>
        <base />
    </outbound>
</policies>

如需使用原則的詳細資訊,請參閱: