Chính sách MonetizeLimitsCheck

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến Tài liệu về Apigee X. thông tin

Tổng quan

Chính sách MonetizationLimitsCheck cho phép bạn thực thi giới hạn kiếm tiền đối với các lệnh gọi API đã thực hiện mà nhà phát triển ứng dụng đưa ra.

Khi chính sách được kích hoạt, có một số trường hợp như sau:

• Nếu một nhà phát triển ứng dụng truy cập vào API kiếm tiền chưa mua gói thuê bao sản phẩm API được liên kết
• Tài khoản của nhà phát triển không có đủ số dư.
• Nhà phát triển đã vượt quá giới hạn số lượng giao dịch.

Để biết thông tin về cách đính kèm chính sách vào proxy API, vui lòng xem Thực thi giới hạn kiếm tiền trên proxy API.

<MonetizationLimitsCheck> phần tử

Xác định chính sách MonetizationLimitsCheck.

Bảng sau đây cung cấp nội dung mô tả cấp cao về các phần tử con của <MonetizationLimitsCheck>:

Phần tử <MonetizationLimitsCheck> sử dụng cú pháp sau:

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

Phần tử này có các thuộc tính chung cho tất cả các chính sách:

Tham chiếu phần tử con

<DisplayName>

Hãy sử dụng cùng với thuộc tính name để gắn nhãn chính sách trong phần trình chỉnh sửa proxy giao diện người dùng quản lý với một cái tên khác, nghe tự nhiên hơn.

Phần tử <DisplayName> áp dụng chung cho mọi chính sách.

Phần tử <DisplayName> sử dụng cú pháp sau:

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

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

Phần tử <DisplayName> không có thuộc tính hoặc phần tử con.

<IgnoreUnresolvedVariables>

Xác định xem có nên dừng quá trình xử lý chính sách này hay không khi Apigee gặp phải biến chưa được giải quyết.

Để bỏ qua các biến chưa được giải quyết và tiếp tục xử lý, hãy đặt giá trị thành true; nếu không thì false. Giá trị mặc định là true.

Việc đặt <IgnoreUnresolvedVariables> thành true khác với việc đặt giá trị của phần tử <MonetizationLimitsCheck> continueOnError đến true. Nếu bạn đặt continueOnError thành true, Apigee sẽ bỏ qua chỉ các lỗi biến mà thôi.

Phần tử <IgnoreUnresolvedVariables> sử dụng cú pháp sau:

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

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

<Variables>

Chỉ định các biến luồng mà từ đó bạn muốn tìm nạp tên thực thể hoặc tên tài nguyên trong quá trình thực thi chính sách.

Bạn chỉ có thể chỉ định phần tử <Product> trong phần tử <Variables>. Apigee nhận được tên sản phẩm API từ biến luồng được chỉ định trong phần tử <Product>. Nếu bạn không chỉ định phần tử <Variables>, Apigee theo mặc định sẽ lấy tên sản phẩm API từ Biến ngữ cảnh apiproduct.name. Bằng cách sử dụng tên sản phẩm API, Apigee sẽ nhận được gói giá tương ứng cho sản phẩm và kiểm tra hạn mức kiếm tiền.

Phần tử <Variables> sử dụng cú pháp sau:

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

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

<Product>

Chỉ định biến có tên sản phẩm API.

Phần tử <Product> sử dụng cú pháp sau:

<Product>VARIABLE_NAME</Product>

<Product>myproductvar.name</Product>

<FaultResponse>

Xác định thông báo phản hồi được trả về cho ứng dụng yêu cầu nếu xảy ra lỗi. Bạn có thể tuỳ chỉnh câu trả lời dựa trên yêu cầu của bạn. Để biết thêm thông tin về và tất cả các phần tử con của nó, xem FaultResponse.

Biến luồng

Nếu bạn đặt giá trị của phần tử <MonetizationLimitsCheck> ContinueOnError thành true, không xảy ra lỗi nào. Trong trường hợp này, biến luồng, mint.limitsViolated, mint.isDeveloperSuspended và mint.limitsPolicyError được đặt tự động. Bạn có thể dùng các biến này để thực hiện thêm việc xử lý ngoại lệ nếu cần.