MonetizationLimitsCheck 정책

이 페이지는 Apigee 및 Apigee Hybrid에 적용됩니다.

Apigee Edge 문서 보기

정책 아이콘

개요

MonetizationLimitsCheck 정책을 사용하면 수익 창출 한도를 적용할 수 있습니다.

특히 수익 창출 API에 액세스하는 앱 개발자가 관련 API 제품에 대한 구독을 구매하지 않은 경우 또는 개발자에게 잔액이 부족한 경우 정책이 트리거됩니다. 이 경우 MonetizationLimitsCheck 정책은 결함을 유발하고 API 호출을 차단합니다. 자세한 내용은 API 제품에 개발자 구독 적용을 참조하세요.

mint 흐름 변수 참조에 설명된 대로 API 프록시에 MonetizationLimitsCheck 정책을 연결하면 mint.limitscheck.* 및 mint.subscription_* 흐름 변수가 채워집니다.

이 정책은 확장 가능한 정책이며, 이 정책을 사용하면 Apigee 라이선스에 따라 비용 또는 사용률이 영향을 받을 수 있습니다. 정책 유형 및 사용 영향에 대한 자세한 내용은 정책 유형을 참조하세요.

<MonetizationLimitsCheck>

MonetizationLimitsCheck 정책을 정의합니다.

기본값 해당 사항 없음
필수 여부 필수
유형 복합 유형
상위 요소 해당 사항 없음
하위 요소 <DisplayName>
<FaultResponse>
<IgnoreUnresolvedVariables>

다음 표에서는 <MonetizationLimitsCheck>의 하위 요소를 간략하게 설명합니다.

하위 요소 필수 여부 설명
<DisplayName> 선택사항 정책의 커스텀 이름입니다.
<FaultResponse> 선택사항 요청 클라이언트로 반환되는 응답 메시지를 정의합니다.
<IgnoreUnresolvedVariables> 선택사항 흐름에서 확인되지 않은 변수 오류를 무시합니다.

<MonetizationLimitsCheck> 요소는 다음 문법을 사용합니다.

구문

<?xml version="1.0" encoding="UTF-8" standalone="no"?><MonetizationLimitsCheck continueOnError="[true|false]" enabled="[true|false]" name="policy_name">
   <DisplayName>POLICY_DISPLAY_NAME</DisplayName>
   <FaultResponse>
        <AssignVariable>
          <Name/>
          <Value/>
        </AssignVariable>
        <Add>
            <Headers/>
        </Add>
        <Copy source="request">
            <Headers/>
            <StatusCode/>
       </Copy>
        <Remove>
            <Headers/>
        </Remove>
        <Set>
            <Headers/>
            <Payload/>
            <StatusCode/>
        </Set>
    </FaultResponse>
    <IgnoreUnresolvedVariables>VALUE</IgnoreUnresolvedVariables>
</MonetizationLimitsCheck>

예

다음 예시에서 개발자가 연관된 API 제품 구독을 구입하지 않은 경우에는 수익 창출 API 액세스가 차단되고 커스텀 메시지와 함께 403 상태가 반환됩니다.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<MonetizationLimitsCheck continueOnError="false" enabled="true" name="MonetizationLimitsCheck-1">
  <DisplayName>Monetization-Limits-Check-1</DisplayName>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <FaultResponse>
    <Set>
      <Payload contentType="text/xml">
        <error>
          <messages>
            <message>Usage has been exceeded ({mint.limitscheck.isRequestBlocked}) or app developer has been suspended</message>
          </messages>
        </error>
      </Payload>
      <StatusCode>403</StatusCode>
    </Set>
  </FaultResponse>
</MonetizationLimitsCheck>

이 요소에는 다음과 같이 모든 정책에 공통된 속성이 있습니다.

속성 기본값 필수 여부 설명
name 해당 사항 없음 필수

정책의 내부 이름입니다. name 속성의 값에는 문자, 숫자, 공백, 하이픈, 밑줄, 마침표가 포함될 수 있습니다. 이 값은 255자(영문 기준)를 초과할 수 없습니다.

원하는 경우 <DisplayName> 요소를 사용하여 관리 UI 프록시 편집기의 정책에 다른 자연어 이름을 사용하여 정책에 라벨을 지정합니다.
continueOnError 거짓 선택사항 정책이 실패할 경우 오류가 반환되도록 하려면 false로 설정합니다. 이는 대부분의 정책에서 예상되는 동작입니다. 정책이 실패해도 흐름 실행이 계속되도록 하려면 true로 설정합니다. 참조:
enabled 참 선택사항 정책을 시행하려면 true로 설정합니다. 정책을 중지하려면 false로 설정합니다. 정책이 흐름에 연결되어 있어도 정책이 시행되지 않습니다.
async   거짓 지원 중단됨 이 속성은 지원이 중단되었습니다.

하위 요소 참조

이 섹션에서는 <MonetizationLimitsCheck>의 하위 요소를 설명합니다.

<DisplayName>

name 속성 외에 이 요소를 사용하여 관리 UI 프록시 편집기에서 자연스러운 다른 이름으로 정책의 라벨을 지정합니다.

<DisplayName> 요소는 모든 정책에 공통으로 적용됩니다.

기본값 해당 사항 없음
필수 여부 선택사항. <DisplayName>을 생략하면 정책의 name 속성 값이 사용됩니다.
유형 문자열
상위 요소 <PolicyElement>
하위 요소 없음

<DisplayName> 요소는 다음 문법을 사용합니다.

구문

<PolicyElement>
  <DisplayName>POLICY_DISPLAY_NAME</DisplayName>
  ...
</PolicyElement>

예

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

<DisplayName> 요소에 속성 또는 하위 요소가 없습니다.

<FaultResponse>

요청 클라이언트로 반환되는 응답 메시지를 정의합니다. FaultResponse는 RaiseFault 정책의 <FaultResponse> 요소와 동일한 설정을 사용합니다.

기본값 해당 사항 없음
필수 여부 선택사항
유형 복합 유형
상위 요소 <MonetizationLimitsCheck>
하위 요소 <AssignVariable>
<Add>
<Copy>
<Remove>
<Set>

<AssignVariable>

대상 흐름 변수에 값을 할당합니다. 흐름 변수가 없으면 AssignVariable이 변수를 만듭니다.

기본값 해당 사항 없음
필수 여부 선택사항
유형 복합 유형
상위 요소 <FaultResponse>
하위 요소 <Name>
<Value>

예를 들어 다음 코드를 사용하여 MonetizationLimitsCheck 정책에서 myFaultVar이라는 변수를 설정합니다.

<FaultResponse>
<AssignVariable>
  <Name>myFaultVar</Name>
  <Value>42</Value>
</AssignVariable>
</FaultResponse>

그러면 오류 규칙의 정책이 변수에 액세스할 수 있습니다. 예를 들어 다음 AssignMessage 정책은 변수를 사용하여 오류 응답에 헤더를 설정합니다.

<AssignMessage enabled="true" name="Assign-Message-1">
<Add>
  <Headers>
    <Header name="newvar">{myFaultVar}</Header>
  </Headers>
</Add>
<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
<AssignTo createNew="false" transport="http" type="response"/>
</AssignMessage>

MonetizationLimitsCheck 정책의 <AssignVariable>은 AssignMessage 정책의 <AssignVariable> 요소와 동일한 문법을 사용합니다.

<Name>

변수 이름입니다. 자세한 내용은 AssignMessage 정책의 이름 요소를 참조하세요.

기본값 해당 사항 없음
필수 여부 선택사항
유형 문자열
상위 요소 <AssignVariable>
하위 요소 없음
<Value>

변수 값입니다. 자세한 내용은 AssignMessage 정책의 값 요소를 참조하세요.

기본값 해당 사항 없음
필수 여부 선택사항
유형 문자열
상위 요소 <AssignVariable>
하위 요소 없음

<Add>

HTTP 헤더를 오류 메시지에 추가합니다.

기본값 해당 사항 없음
필수 여부 선택사항
유형 복합 유형
상위 요소 <FaultResponse>
하위 요소 <Headers>
<Headers>

추가, 설정, 복사, 삭제할 HTTP 헤더를 지정합니다.

기본값 해당 사항 없음
필수 여부 선택사항
유형 복합 유형
상위 요소 <Add>
<Copy>
<Remove>
<Set>
하위 요소 없음

예:

헤더 추가

다음 예시에서는 request.user.agent 흐름 변수의 값을 헤더에 복사합니다.

<Add>
    <Headers>
        <Header name="user-agent">{request.user.agent}</Header>
    </Headers>
</Add>
헤더 설정

다음 예시에서는 user-agent 헤더를 <AssignTo> 요소로 지정된 메시지 변수로 설정합니다.

<Set>
    <Headers>
        <Header name="user-agent">{request.header.user-agent}</Header>
    </Headers>
</Set>
헤더 복사 - 1

다음 예시에서는 요청에서 headerA를 복사합니다.

<Copy source='request'>
    <Headers>
        <Header name="headerA"/>
    </Headers>
</Copy>
헤더 복사 - 2

다음 예시에서는 여러 헤더를 복사합니다.

<Copy source='request'>
    <Headers>
      <Header name="h1"/>
      <Header name="h2"/>
      <Header name="h3.2"/>
    </Headers>
</Copy>

이 예시에서는 'h1', 'h2', 'h3'의 두 번째 값을 복사합니다. 'h3'에 값이 하나만 있으면 'h3'이 복사되지 않습니다.

헤더 삭제 - 1

다음 예시에서는 헤더를 삭제합니다.

<Remove>
    <Headers>
        <Header name="user-agent"/>
    </Headers>
</Remove>
헤더 삭제 - 2

다음 예시에서는 여러 헤더를 삭제합니다.

<Remove>
    <Headers>
      <Header name="h1"/>
      <Header name="h2"/>
      <Header name="h3.2"/>
    </Headers>
</Remove>

이 예시에서는 'h1', 'h2'와 'h3'의 두 번째 값을 삭제합니다. 'h3'에 값이 하나만 있으면 'h3'이 삭제되지 않습니다.

<Copy>

source 속성으로 지정된 메시지에서 부터 오류 메시지로 정보를 복사합니다.

기본값 해당 사항 없음
필수 여부 선택사항
유형 복합 유형
상위 요소 <FaultResponse>
하위 요소 <Headers>
<StatusCode>

다음 표는 <Copy>의 속성을 설명합니다.

속성 필수 여부 유형 설명
source 선택사항 문자열

사본의 소스 객체를 지정합니다.

  • 소스를 지정하지 않으면 단순 메시지로 취급됩니다. 예를 들어 정책이 요청 흐름에 있는 경우 소스가 기본적으로 요청 객체로 지정됩니다. 정책이 응답 흐름에 있으면 기본적으로 응답 객체로 지정됩니다. 소스를 생략하면 흐름 변수에 대한 절대 참조를 복사본의 소스로 사용할 수 있습니다. 예를 들어 값을 {request.header.user-agent}로 지정합니다.
  • 소스 변수를 확인할 수 없거나 메시지 외의 유형으로 확인되면 <Copy>가 응답하지 않습니다.
<StatusCode>

오류 메시지에 HTTP 상태 코드를 지정합니다. source 속성으로 지정된 객체에 대해 값을 복사하거나 설정할 수 있습니다.

기본값 해당 사항 없음
필수 여부 선택사항
유형 복합 유형
상위 요소 <Copy>
<Set>
하위 요소 없음

예:

상태 코드 복사
<Copy source='response'>
    <StatusCode>404</StatusCode>
</Copy>
상태 코드 설정
<Set source='request'>
    <StatusCode>404</StatusCode>
</Set>

<Remove>

오류 메시지에서 지정된 HTTP 헤더를 삭제합니다. 모든 헤더를 삭제하려면 <Remove><Headers/></Remove>를 지정합니다.

기본값 해당 사항 없음
필수 여부 선택사항
유형 복합 유형
상위 요소 <FaultResponse>
하위 요소 <Headers>

<Set>

오류 메시지에 정보를 설정합니다.

기본값 해당 사항 없음
필수 여부 선택사항
유형 복합 유형
상위 요소 <FaultResponse>
하위 요소 <Headers>
<Payload>
<StatusCode>
<Payload>

오류 메시지의 페이로드를 설정합니다.

기본값 해당 사항 없음
필수 여부 선택사항
유형 문자열
상위 요소 <Set>
하위 요소 없음

예:

텍스트 페이로드 설정
<Set>
    <Payload contentType="text/plain">test1234</Payload>
</Set>
JSON 페이로드 설정 - 1
<Set>
    <Payload contentType="application/json">
        {"name":"foo", "type":"bar"}
    </Payload>
</Set>
JSON 페이로드 설정 - 2
<Set>
    <Payload contentType="application/json" variablePrefix="@" variableSuffix="#">
        {"name":"foo", "type":"@variable_name#"}
    </Payload>
</Set>

이 예시에서는 구분 기호 문자와 함께 variablePrefix 및 variableSuffix 속성을 사용하여 변수를 삽입합니다.

JSON 페이로드 설정 - 3
<Set>
    <Payload contentType="application/json">
        {"name":"foo", "type":"{variable_name}"}
    </Payload>
</Set>

이 예시에서는 중괄호를 사용하여 변수를 삽입합니다. 16.08.17 출시 버전부터 시작해서 중괄호를 사용할 수 있습니다.

XML 페이로드 설정
<Set>
    <Payload contentType="text/xml">
        <root>
          <e1>sunday</e1>
          <e2>funday</e2>
          <e3>{var1}</e3>
    </Payload>
</Set>

이 예시에서는 중괄호를 사용하여 변수를 삽입합니다. 16.08.17 출시 버전부터 시작해서 중괄호를 사용할 수 있습니다.

<IgnoreUnresolvedVariables>

해결되지 않은 변수가 발생하면 처리를 중지할지 여부를 결정합니다.

확인되지 않은 변수를 무시하고 계속 처리하려면 true로 설정합니다. 그렇지 않으면 false로 설정합니다. 기본값은 true입니다.

<IgnoreUnresolvedVariables>를 true로 설정하는 것은 <MonetizationLimitsCheck>의 continueOnError를 true로 설정하는 것과 다릅니다. continueOnError를 true로 설정하면 Apigee가 모든 오류를 무시하지만 변수의 오류를 무시하지 않습니다.

<IgnoreUnresolvedVariables> 요소는 다음 문법을 사용합니다.

구문

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

예

다음 예시에서는 <IgnoreUnresolvedVariables>를 false로 설정합니다.

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

오류 코드

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Fault code HTTP status Cause
mint.service.subscription_not_found_for_developer 500 This error occurs when a developer does not have a subscription to the API Product.
mint.service.wallet_not_found_for_developer 500 This error occurs when a prepaid developer attempts to consume a monetized API without maintaining a wallet for the currency specified in rate plan.
mint.service.developer_usage_exceeds_balance 500 This error occurs when a prepaid developer's usage exceeds the wallet balance.
mint.service.wallet_blocked_due_to_inactivity 500 This error occurs when a prepaid developer's wallet is not topped up in over 1.5 years and the developer attempts to consume an API.

Fault variables

Whenever there are execution errors in a policy, Apigee generates error messages. You can view these error messages in the error response. Many a time, system generated error messages might not be relevant in the context of your product. You might want to customize the error messages based on the type of error to make the messages more meaningful.

To customize the error messages, you can use either fault rules or the RaiseFault policy. For information about differences between fault rules and the RaiseFault policy, see FaultRules vs. the RaiseFault policy. You must check for conditions using the Condition element in both the fault rules and the RaiseFault policy. Apigee provides fault variables unique to each policy and the values of the fault variables are set when a policy triggers runtime errors. By using these variables, you can check for specific error conditions and take appropriate actions. For more information about checking error conditions, see Building conditions.

Variables Where Example
fault.name The fault.name can match to any of the faults listed in the Runtime errors table. The fault name is the last part of the fault code. fault.name Matches "UnresolvedVariable"
MonetizationLimitsCheck.POLICY_NAME.failed POLICY_NAME is the user-specified name of the policy that threw the fault. MonetizationLimitsCheck.monetization-limits-check-1.failed = true
For more information about policy errors, see What you need to know about policy errors

흐름 변수

MonetizationLimitsCheck 정책이 실행되면 다음과 같은 사전 정의된 흐름 변수가 자동으로 채워집니다. 자세한 내용은 mint 흐름 변수를 참조하세요.

흐름 변수 설명
mint.limitscheck.is_request_blocked true: 차단된 요청의 경우
mint.limitscheck.is_subscription_found true: API 구독이 있는 경우
mint.limitscheck.purchased_product_name 구매한 API 제품의 이름입니다. 예를 들면 MyProduct입니다.
mint.limitscheck.status_message 상태 메시지입니다. 다음 값이 반환될 수 있습니다.
  • limits_check_success - 한도 확인이 성공했습니다.
  • apiproduct_name_and_developer_email_not_available - 한도 확인을 위해 API 개발자 또는 API 제품 이름을 확인할 수 없습니다.
  • apiproduct_name_not_available - 한도 확인을 위해 API 제품 이름을 확인할 수 없습니다.
  • developer_email_not_available - 한도 확인을 위해 API 개발자 이메일을 확인할 수 없습니다.
  • developer_usage_exceeds_balance - 선불 개발자 잔액이 너무 적습니다.
  • rateplan_not_available - 요금제가 없는 API 제품, 오류 없음
  • subscription_not_available - 앱을 소유한 API 개발자에게 구독이 없습니다.
  • wallet_disabled_due_to_inactivity - 개발자가 1년 이상 월렛을 사용하지 않았습니다. 최소 1단위(달러로 환산 시 0.01달러)를 충전하면 다시 활성화됩니다.
  • wallet_not_found - 개발자에게 월렛이 없습니다. 이 문제는 해당 개발자에 대해 잔액 충전이 실행되지 않은 경우에 발생할 수 있습니다.
mint.subscription_end_time_ms API 제품 구독의 종료 시간입니다.
mint.subscription_start_time_ms API 제품 구독의 시작 시간입니다. 예를 들면 1618433956209입니다.