ResetQuota 정책

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

Apigee Edge 문서 보기

정책 아이콘

대상

대상 할당량 정책에서 허용하는 나머지 요청 수를 동적으로 수정하는 데 사용합니다. 할당량 개수가 재설정될 때까지 기다리는 대신 일반적으로 이 정책을 사용하여 대상 할당량 정책의 현재 할당량 수를 줄입니다.

예를 들어 대상 할당량 정책은 개발자의 요청을 매주 1,000개로 제한합니다. 해당 주의 둘째 날, 개발자는 이미 이 한도에 도달했습니다. Reset Quota 정책을 사용하여 할당량 카운터에서 500개를 빼고 해당 주의 나머지 기간 동안 추가 500개의 요청을 허용합니다. 해당 주의 마지막 날, 할당량 정책은 재설정되고 다가오는 주에 대한 개발자의 한도는 요청 1,000개로 돌아갑니다.

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

할당량 정책에 대한 자세한 내용은 할당량 정책을 참조하세요. Reset Quota 정책 사용에 대한 자세한 내용은 이 커뮤니티 게시물도 참조하세요.

샘플

다음 정책 코드 샘플은 할당량 카운터를 재설정하는 방법을 보여줍니다.

기본 카운터 재설정

<ResetQuota name="resetQuota">
   <Quota name="MyQuotaPolicy">
      <Identifier name="_default">
         <Allow>100</Allow>
      </Identifier>
   </Quota>
</ResetQuota>

Reset Quota 정책은 <Quota> 태그의 name 속성을 사용하여 대상 할당량 정책을 지정합니다. 위의 예시에서는 MyQuotaPolicy 정책이 대상입니다.

모든 Reset Quota 정책에는 업데이트할 할당량 정책의 카운터를 지정하는 <Identifier> 태그가 필요합니다. 기본적으로 할당량 정책에는 단일 카운터가 있습니다. 단, 할당량 정책에는 <Identifier> 태그도 포함됩니다. 이 예시에서는 대상 할당량 정책이 <Identifier> 태그를 사용하지 않으므로 name 속성을 _default로 지정합니다.

<Allow> 요소는 대상 정책의 현재 할당량 수를 줄이는 데 사용되는 값을 지정합니다. 이 예시에서는 대상 할당량 정책에 대한 추가 요청 100개를 허용하기 위해 할당량 수를 100개로 줄입니다. 대상 할당량 정책이 재설정되면 이 변경사항은 삭제됩니다.

다음은 대상 할당량 정책의 정의입니다.

<Quota name="MyQuotaPolicy">
  <Interval>5</Interval>
  <TimeUnit>hour</TimeUnit>
  <Allow count="100"/>
</Quota>

참조 사용

<ResetQuota name="resetQuota">
   <Quota ref="request.header.quotapolicy">
      <Identifier name="_default">
         <Allow ref="request.header.allowquota" />
      </Identifier>
   </Quota>
</ResetQuota>

이 예시에서는 대상 할당량 정책의 이름 및 할당량 수의 변경사항을 요청의 헤더로 전달합니다. 그런 다음 Reset Quota 정책에서 이러한 값을 포함한 흐름 변수를 참조할 수 있습니다.

식별자 지정

<ResetQuota name="resetQuota">
   <Quota name="QuotaPolicy">
      <Identifier ref="request.header.clientId">
         <Allow>100</Allow>
      </Identifier>
   </Quota>
</ResetQuota>

대상 할당량 정책에 <Identifier> 태그가 지정되어 있으면 특정 할당량 수를 업데이트 하기 위해 Reset Quota 정책의 <Identifier> 태그에 동일한 값을 지정할 수 있습니다. 아래의 대상 할당량 정책의 <Identifier> 태그가 Reset Quota 정책에 지정된 값과 어떻게 일치하는지 확인하세요. 

<Quota name="QuotaPolicy">
  <Identifier ref="request.header.clientId"/> 
  <Interval>5</Interval>
  <TimeUnit>hour</TimeUnit>
  <Allow count="100"/>
</Quota>

요소 참조

요소 참조는 Reset Quota 정책의 요소 및 속성을 설명합니다.

<ResetQuota async="false" continueOnError="false" enabled="true" name="Reset-Quota-1">
   <DisplayName>Reset Quota 1</DisplayName>
   <Quota name="quotaName" ref="request.header.quotapolicy">
      <Identifier name="identifierName" ref="request.header.identifier">
         <Class ref="request.header.classIdentifier" />
         <Allow>100</Allow>
      </Identifier>
   </Quota>
</ResetQuota>

<ResetQuota> 속성

<ResetQuota async="false" continueOnError="false" enabled="true" name="Reset-Quota-1">

다음 표는 모든 정책 상위 요소의 공통 속성에 대해 설명합니다.

속성 설명 기본값 Presence
name

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

원하는 경우 <DisplayName> 요소를 사용하여 관리 UI 프록시 편집기의 정책에 다른 자연어 이름을 사용하여 정책에 라벨을 지정합니다.

 해당 사항 없음 필수
continueOnError

정책이 실패할 경우 오류가 반환되도록 하려면 false로 설정합니다. 이는 대부분의 정책에서 예상되는 동작입니다.

정책이 실패해도 흐름 실행이 계속되도록 하려면 true로 설정합니다. 참조:

 false 선택사항
enabled

정책을 시행하려면 true로 설정합니다.

정책을 중지하려면 false로 설정합니다. 정책이 흐름에 연결되어 있어도 정책이 시행되지 않습니다.

 true 선택사항
async

이 속성은 지원이 중단되었습니다.

 false 지원 중단됨

<DisplayName> 요소

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

<DisplayName>Policy Display Name</DisplayName>
기본값

해당 사항 없음

이 요소를 생략하면 정책 name 속성 값이 사용됩니다.
Presence 선택사항
유형 문자열

<Quota> 요소

카운터가 업데이트되어야 하는 대상 할당량 정책을 식별합니다.

<Quota name="quotaName"  ref="request.header.quotapolicy">
   <Identifier name="identifierName" ref="request.header.identifier">
      <Allow>100</Allow>
   </Identifier>
</Quota>
기본값: 해당 사항 없음
Presence: 필수
유형: 해당 사항 없음

속성

속성 설명 기본값 Presence
이름

대상 할당량 정책의 이름을 지정합니다.

 해당 사항 없음 선택사항
ref 대상 할당량 정책의 이름이 포함된 흐름 변수입니다. ref 및 name이 모두 지정된 경우 ref가 우선 적용됩니다. ref가 런타임 시 확인되지 않으면 name이 사용됩니다. 해당 사항 없음 선택사항

<Quota>/<Identifier> 요소

대상 할당량 정책이 <Identifier> 태그를 지정하는 경우 카운터를 고유하게 식별하는 데 사용되는 변수입니다.

<Quota name="quotaName">
   <Identifier name="identifierName" ref="request.header.identifier">
      <Allow>100</Allow>
   </Identifier>
</Quota>
기본값: 해당 사항 없음
Presence: 필수
유형: 문자열

속성

속성 설명 기본값 Presence
이름

대상 할당량 정책에 집계 식별자의 이름을 지정합니다. <Identifier> 태그를 사용하지 않는 할당량 정책의 경우 _default를 지정합니다.

 해당 사항 없음 선택사항
ref

대상 할당량 정책에 집계 식별자 이름이 포함된 흐름 변수입니다. ref 및 name이 모두 지정된 경우 ref가 우선 적용됩니다. ref가 런타임 시 확인되지 않으면 name이 사용됩니다.

 해당 사항 없음 선택사항

<Quota>/<Identifier>/<Allow> 요소

줄일 할당량 카운터의 양을 지정합니다. <Allow>를 지정해야 하며, 그렇지 않으면 정책이 할당량을 수정하지 않습니다.

<Identifier name="identifierName" ref="request.header.identifier">
   <Allow ref="request.header.allowquota">100</Allow>
</Identifier>
기본값: 해당 사항 없음
Presence: 필수
유형: 정수

속성

속성 설명 기본값 Presence
ref

대상 할당량 정책의 할당량 수 변경사항이 포함된 흐름 변수입니다.

 해당 사항 없음 선택사항

<Quota>/<Identifier>/<Class> 요소

할당량 카운터가 업데이트되는 클래스를 지정합니다. 할당량 정책에 클래스를 사용하는 방법에 대한 자세한 내용은 할당량 정책을 참조하세요. 

<Identifier name="_default">
   <Class ref="request.header.classIdentifier">
     <Allow>200</Allow>
   </Class>
</Identifier>
기본값: 해당 사항 없음
Presence: 선택사항
유형: 해당 사항 없음

속성

속성 설명 기본값 Presence
ref

업데이트할 할당량 클래스가 포함된 흐름 변수를 참조합니다.

 해당 사항 없음 선택사항

오류 참조

이 섹션에서는 반환되는 오류 코드 및 오류 메시지와 이 정책이 오류를 트리거할 때 Apigee에서 설정한 오류 변수를 설명합니다. 오류를 처리하기 위해 오류 규칙을 개발 중인 경우, 이 정보는 중요합니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항 및 오류 처리를 참조하세요.

런타임 오류

이러한 오류는 정책이 실행될 때 발생할 수 있습니다.

오류 코드 HTTP 상태 원인 해결
policies.resetquota.InvalidRLPolicy 500 ResetQuota 정책의 <Quota> 요소에 지정된 Quota 정책은 API 프록시에 정의되어 있지 않으므로 흐름 중에 사용할 수 없습니다. <Quota> 요소는 필수이며 ResetQuota 정책을 통해 카운터가 업데이트되어야 하는 대상 Quota 정책을 식별합니다.
policies.resetquota.FailedToResolveAllowCountRef 해당 없음 정책의 <Allow> 요소에서 허용 개수를 포함한 변수 참조를 값으로 확인할 수 없습니다. 이 요소는 필수이며 줄일 할당량 카운터의 양을 지정합니다.
policies.resetquota.FailedToResolveRLPolicy 500 <Quota> 요소의 ref 속성에서 참조한 변수는 확인할 수 없습니다.

배포 오류

이 오류는 이 정책이 포함된 프록시를 배포할 때 발생할 수 있습니다.

오류 이름 원인 해결
InvalidCount ResetQuota 정책의 <Allow> 요소에 지정된 카운트 값이 정수가 아니면 API 프록시 배포가 실패합니다.

스키마

관련 주제

할당량 정책