Chính sách MonetizeLimitsCheck

Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào tài liệu Apigee X. thông tin

Tổng quan

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

Sau đây là một số trường hợp chính sách này được áp dụng:

• Nếu 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 cho 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 về 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, hãy xem bài viết Thực thi hạn mức kiếm tiền trên proxy API.

Phần tử <MonetizationLimitsCheck>

Chỉ đị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:

Tài liệu tham khảo về phần tử con

<DisplayName>

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

Phần tử <DisplayName> là phần tử chung cho tất cả các 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 quá trình xử lý chính sách có nên dừng lại khi Apigee gặp phải một biến chưa được giải quyết hay không.

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

Việc đặt <IgnoreUnresolvedVariables> thành true khác với việc đặt continueOnError của phần tử <MonetizationLimitsCheck> thành true. Nếu bạn đặt continueOnError thành true, Apigee sẽ bỏ qua không chỉ các lỗi biến mà còn tất cả các lỗ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à 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 lấy 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>, theo mặc định, Apigee 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à thực hiện kiểm tra giới hạn 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 khách yêu cầu nếu có lỗi xảy ra. Bạn có thể tuỳ chỉnh thông báo phản hồi dựa trên yêu cầu của mình. Để biết thêm thông tin về phần tử và tất cả phần tử con của phần tử này, hãy xem FaultResponse.

Biến dòng

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