Ограничения монетизацииПроверьте политику

Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info

Обзор

Политика MonetizationLimitsCheck позволяет устанавливать ограничения на монетизацию вызовов API, выполняемых разработчиком приложения.

К числу случаев, когда срабатывает данная политика, относятся:

• Если разработчик приложения, использующий монетизированный API, не приобрел подписку на соответствующий продукт API,
• На счету разработчика недостаточно средств.
• Разработчик превысил лимит объема транзакций.

Информацию о том, как прикрепить политику к вашему API-прокси, см. в разделе «Применение ограничений монетизации к API-прокси» .

<MonetizationLimitsCheck> элемент

Указывает политику MonetizationLimitsCheck.

В следующей таблице приведено общее описание дочерних элементов <MonetizationLimitsCheck> :

Элемент <MonetizationLimitsCheck> использует следующий синтаксис:

<?xml version="1.0" encoding="UTF-8"?>
<MonetizationLimitsCheck async="false" continueOnError="false" enabled="true" name="POLICY_NAME">
    <DisplayName>DISPLAY_NAME</DisplayName>
    <IgnoreUnresolvedVariables>[true|false]</IgnoreUnresolvedVariables>
    <Variables>
        <Product>VARIABLE_NAME</Product>
    </Variables>
    <FaultResponse>
        <Set>
            <Payload contentType="text/xml">
                <error>
                    <messages>
                        <message>MESSAGE_TEXT</message>
                        <message>MESSAGE_TEXT</message>
                    </messages>
                </error>
            </Payload>
            <StatusCode>HTTP_STATUS</StatusCode>
            <ReasonPhrase>REASON_TEXT</ReasonPhrase>
        </Set>
    </FaultResponse>
</MonetizationLimitsCheck>

<?xml version="1.0" encoding="UTF-8"?>
<MonetizationLimitsCheck async="false" continueOnError="false" enabled="true" name="Monetization-Limits-Check">
    <DisplayName>Monetization Limits Check</DisplayName>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <Variables>
        <Product>myproductvar.name</Product>
    </Variables>
	<FaultResponse>
	        <Set>
	            <Payload contentType="text/xml">
	                <error>
	                    <messages>
	                        <message>Developer has reached usage quota</message>
	                        <message>Is Developer Suspended - {monetizationLimits.isDeveloperSuspended} </message>
	                    </messages>
	                </error>
	            </Payload>
	            <StatusCode>403</StatusCode>
	            <ReasonPhrase>Forbidden</ReasonPhrase>
	        </Set>
	</FaultResponse>
 </MonetizationLimitsCheck>

Этот элемент имеет следующие атрибуты, общие для всех политик:

ссылка на дочерний элемент

<DisplayName>

Используйте в дополнение к атрибуту name , чтобы обозначить политику в редакторе прокси-сервера пользовательского интерфейса управления другим, более естественно звучащим именем.

Элемент <DisplayName> является общим для всех политик.

Элемент <DisplayName> использует следующий синтаксис:

<PolicyElement>
  <DisplayName>policy_display_name</DisplayName>
  ...
</PolicyElement>

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

Элемент <DisplayName> не имеет атрибутов или дочерних элементов.

<IgnoreUnresolvedVariables>

Определяет, следует ли остановить обработку политики, когда Apigee обнаруживает неразрешенную переменную.

Чтобы игнорировать неразрешенные переменные и продолжить обработку, установите значение true ; в противном случае false . Значение по умолчанию — true .

Установка параметра <IgnoreUnresolvedVariables> в true отличается от установки continueOnError элемента <MonetizationLimitsCheck> в true . Если вы установите continueOnError в true , Apigee будет игнорировать не только ошибки переменных, но и все ошибки.

Элемент <IgnoreUnresolvedVariables> использует следующий синтаксис:

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

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

<Variables>

Указывает переменные потока, из которых вы хотите получить имена сущностей или ресурсов во время выполнения политики.

Внутри элемента <Variables> можно указать только элемент <Product> . Apigee получает имя продукта API из переменной потока, указанной в элементе <Product> . Если элемент <Variables> не указан, Apigee по умолчанию получает имя продукта API из контекстной переменной apiproduct.name . Используя имя продукта API, Apigee получает соответствующий тарифный план для продукта и выполняет проверку лимитов монетизации.

Элемент <Variables> использует следующий синтаксис:

<Variables>
    <Product>VARIABLE_NAME</Product>
</Variables>

<Variables>
    <Product>myproductvar.name</Product>
</Variables>

<Product>

Указывает переменную, содержащую название продукта API.

Элемент <Product> использует следующий синтаксис:

<Product>VARIABLE_NAME</Product>

<Product>myproductvar.name</Product>

<FaultResponse>

Определяет ответное сообщение, возвращаемое запрашивающему клиенту в случае возникновения ошибки. Вы можете настроить ответные сообщения в соответствии со своими требованиями. Для получения дополнительной информации об элементе и всех его дочерних элементах см. FaultResponse .

Переменные потока

Если установить атрибут ContinueOnError элемента <MonetizationLimitsCheck> в значение true, ошибка не будет сгенерирована. В этом случае автоматически устанавливаются переменные потока mint.limitsViolated , mint.isDeveloperSuspended и mint.limitsPolicyError . При необходимости эти переменные можно использовать для дальнейшей обработки исключений.