Правило MonetizationLimitsCheck

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

Обзор

Правило 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.

Установка значения true для элемента <IgnoreUnresolvedVariables> отличается от установки значения true для элемента continueOnError в <MonetizationLimitsCheck>. Если вы зададите для 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 будут заданы автоматически. Эти переменные можно использовать для дальнейшей обработки исключений, если это необходимо.