Задание квоты использования по подписке

  • Статья

ОБЛАСТЬ ПРИМЕНЕНИЯ: все уровни Управление API

Политика quota принудительно устанавливает возобновляемую или действующую в течение срока службы квоту на число вызовов и (или) квоту пропускной способности для каждой подписки. При превышении квоты вызывающий объект получает код состояния ответа 403 Forbidden, и ответ включает заголовок Retry-After, значение которого представляет собой рекомендуемый интервал повтора в секундах.

Сведения о разнице между ограничениями скорости и квотами см. в разделе "Пределы скорости и квоты".

Примечание.

Когда базовые вычислительные ресурсы перезапускаются на платформе службы, Управление API может продолжать обрабатывать запросы в течение короткого периода после достижения квоты.

Примечание.

Задайте элементы политики и дочерние элементы в порядке, указанном в правиле политики. Узнайте, как устанавливать или изменять политики службы управления API.

Правило политики

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

Атрибуты

Атрибут Description Обязательное поле По умолчанию.
bandwidth Максимальное общее число килобайтов, разрешенное в течение периода времени, указанного в renewal-period. Выражения политики не допускаются. Необходимо указать атрибут calls, bandwidth или оба вместе. Н/П
вызывает Максимальное общее число вызовов, разрешенное в течение периода времени, указанного в renewal-period. Выражения политики не допускаются. Необходимо указать атрибут calls, bandwidth или оба вместе. Н/П
renewal-period Длина фиксированного периода в секундах, по истечении которого квота сбрасывается. Начало каждого периода вычисляется относительно времени начала подписки. Если для параметра renewal-period задано значение 0, период не ограничен. Выражения политики не допускаются. Да Н/П

Элементы

Элемент Description Обязательное поле
api Добавьте один или несколько таких элементов, чтобы установить квоту вызовов для интерфейсов API в пределах продукта. Квоты для продукта и вызовов API применяются раздельно. Ссылаться на API можно с помощью name или id. Если указаны оба атрибута, id будет использоваться, а name — игнорироваться. No
Операция Добавьте один или несколько таких элементов, чтобы установить квоту вызовов для операций в API. Квоты для продукта, API и вызовов операций применяются раздельно. Ссылаться на операцию можно с помощью name или id. Если указаны оба атрибута, id будет использоваться, а name — игнорироваться. No

Атрибуты API

Атрибут Description Обязательное поле По умолчанию.
name Имя API, для которого применяется ограничение квоты вызова. id Необходимо указать либоname. Н/П
id Идентификатор API, для которого применяется ограничение квоты вызова. id Необходимо указать либоname. Н/П
bandwidth Максимальное общее число килобайтов, разрешенное в течение периода времени, указанного в renewal-period. Выражения политики не допускаются. Необходимо указать атрибут calls, bandwidth или оба вместе. Н/П
вызывает Максимальное общее число вызовов, разрешенное в течение периода времени, указанного в renewal-period. Выражения политики не допускаются. Необходимо указать атрибут calls, bandwidth или оба вместе. Н/П
renewal-period Длина фиксированного периода в секундах, по истечении которого квота сбрасывается. Начало каждого периода вычисляется относительно времени начала подписки. Если для параметра renewal-period задано значение 0, период не ограничен. Выражения политики не допускаются. Да Н/П

Атрибуты операции

Атрибут Description Обязательное поле По умолчанию.
name Имя операции, для которой применяется ограничение квоты вызова. id Необходимо указать либоname. Н/П
id Идентификатор операции, для которой применяется ограничение квоты вызова. id Необходимо указать либоname. Н/П
bandwidth Максимальное общее число килобайтов, разрешенное в течение периода времени, указанного в renewal-period. Выражения политики не допускаются. Необходимо указать атрибут calls, bandwidth или оба вместе. Н/П
вызывает Максимальное общее число вызовов, разрешенное в течение периода времени, указанного в renewal-period. Выражения политики не допускаются. Необходимо указать атрибут calls, bandwidth или оба вместе. Н/П
renewal-period Длина фиксированного периода в секундах, по истечении которого квота сбрасывается. Начало каждого периода вычисляется относительно времени начала подписки. Если для параметра renewal-period задано значение 0, период не ограничен. Выражения политики не допускаются. Да Н/П

Использование

Примечания об использовании

  • Эту политику можно использовать только один раз для определения политики.
  • Эта политика применяется только при доступе к API с помощью ключа подписки.

Пример

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

Связанный контент

Дополнительные сведения о работе с политиками см. в нижеуказанных статьях.