SpikeArrest 정책

<ph type="x-smartling-placeholder"></ph> 현재 Apigee Edge 문서를 보고 있습니다.
Apigee X 문서. 정보

급증 저지 정책은 <Rate> 요소를 사용하여 트래픽 급증으로부터 보호합니다. 이 요소는 API 프록시가 처리하고 백엔드로 전송되는 요청 수를 제한하여 성능 지연 및 다운타임으로부터 보호합니다.

<SpikeArrest> 요소

급증 저지 정책을 정의합니다.

<SpikeArrest
  continueOnError="[false|true]"
  enabled="[true|false]"
  name="policy_name"
>
  <DisplayName>display_name</DisplayName>
  <Properties/>
  <Identifier ref="flow_variable"/>
  <MessageWeight ref="flow_variable"/>
  <Rate ref="flow_variable">rate[pm|ps]</Rate>
  <UseEffectiveCount>[false|true]</UseEffectiveCount>
</SpikeArrest>

<SpikeArrest async="false" continueOnError="false" enabled="true" name="Spike-Arrest-1">
  <DisplayName>Spike Arrest-1</DisplayName>
  <Properties/>
  <Identifier ref="request.header.some-header-name"/>
  <MessageWeight ref="request.header.weight"/>
  <Rate>30ps</Rate>
  <UseEffectiveCount>true</UseEffectiveCount>
</SpikeArrest>

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

예

다음 예시에서는 급증 저지 정책을 사용하는 몇 가지 방법을 보여줍니다.

<SpikeArrest name="Spike-Arrest-1">
  <Rate>5ps</Rate>
</SpikeArrest>

<SpikeArrest name="Spike-Arrest-1">
  <Rate>12pm</Rate>
</SpikeArrest>

<SpikeArrest name="Spike-Arrest-1">
  <Rate>12pm</Rate>
  <Identifier ref="client_id" />
  <MessageWeight ref="request.header.weight" />
</SpikeArrest>

<SpikeArrest name="Spike-Arrest-1">
  <Rate ref="request.header.runtime_rate" />
</SpikeArrest>

curl http://myorg-myenv.apigee.net/price -H 'runtime_rate:30ps'

하위 요소 참조

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

<DisplayName>

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

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

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

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

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

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

<Identifier>

클라이언트에 따라 급증 저지 정책을 적용할 수 있도록 요청을 그룹화하는 방법을 선택할 수 있습니다. 예를 들어 개발자 ID별로 요청을 그룹화할 수 있으며, 이 경우 각 개발자의 요청은 해당 프록시의 모든 요청이 아닌 자체 급증 저지 비율로 계산됩니다.

요청 제한을 보다 세밀하게 제어하려면 <MessageWeight> 요소와 함께 사용합니다.

<Identifier> 요소를 비워 두면 해당 API 프록시에 대한 모든 요청에 한 개의 비율 제한이 적용됩니다.

<SpikeArrest
  continueOnError="[false|true]"
  enabled="[true|false]"
  name="policy_name"
>
  <Identifier ref="flow_variable"/>
</SpikeArrest>
        

<SpikeArrest name="Spike-Arrest-1">
  <Identifier ref="developer.id"/>
  <Rate>42pm</Rate/>
</SpikeArrest>

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

이 요소는 Apigee 커뮤니티 게시물(http://community.apigee.com/questions/2807/how-does-the-edge-quota-policy-work-when-no-identi.html)에서도 설명합니다.

<MessageWeight>

각 메시지에 정의된 가중치를 지정합니다. 메일 가중치는 영향을 수정함 요청 1건이라고 할 수 있습니다. 메시지 가중치는 HTTP 헤더, 쿼리 매개변수, 양식 매개변수, 메시지 본문 콘텐츠와 같은 모든 흐름 변수가 될 수 있습니다. 자바스크립트 정책 또는 AssignMessage 정책을 사용하여 커스텀 변수를 사용할 수도 있습니다.

<Identifier>와 함께 사용하여 특정 클라이언트 또는 앱별로 요청을 추가로 제한할 수 있습니다.

예를 들어 급증 저지 <Rate>가 10pm이고 앱이 가중치가 2인 요청을 제출할 경우 각 요청이 2개로 계산되므로 해당 클라이언트에서 분당 5개의 메시지만 허용됩니다.

<SpikeArrest
  continueOnError="[false|true]"
  enabled="[true|false]"
  name="policy_name"
>
  <MessageWeight ref="flow_variable"/>
</SpikeArrest>

<SpikeArrest name="Spike-Arrest-1">
  <Rate>12pm</Rate>
  <Identifier ref="client_id" />
  <MessageWeight ref="request.header.weight" />
</SpikeArrest>

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

<Rate>

분당 또는 초당 간격으로 허용되는 요청 수를 설정하여 트래픽 급증(또는 버스트)을 제한하는 비율을 지정합니다. 이 요소를 <Identifier> 및 <MessageWeight>와 함께 사용하여 클라이언트의 값을 허용해 런타임에 트래픽을 원활하게 조절할 수도 있습니다.

<SpikeArrest
  continueOnError="[false|true]"
  enabled="[true|false]"
  name="policy_name"
>
  <Rate ref="flow_variable">rate[pm|ps]</Rate>
</SpikeArrest>

<SpikeArrest name="Spike-Arrest-1">
  <Rate>5ps</Rate>
</SpikeArrest>

<SpikeArrest name="Spike-Arrest-1">
  <Rate>12pm</Rate>
</SpikeArrest>

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

<Rate ref="request.header.custom_rate">1pm</Rate>

<UseEffectiveCount>

자동 확장을 사용할 때 Spike Arrest 수를 메시지 프로세서 (MP)에 분산합니다. 액세스할 수 있습니다

<SpikeArrest
  continueOnError="[false|true]"
  enabled="[true|false]"
  name="policy_name"
>
  <UseEffectiveCount>[false|true]</UseEffectiveCount>
</SpikeArrest>

<SpikeArrest name='Spike-Arrest-1'>
  <Rate>40ps</Rate>
  <UseEffectiveCount>true</UseEffectiveCount>
</SpikeArrest>

<UseEffectiveCount> 요소는 선택사항입니다. 기본값은 false입니다. 'Spake Arrest 정책'에서 요소가 생략된 경우

다음 표에서는 <UseEffectiveCount> 요소의 속성을 설명합니다.

<UseEffectiveCount>의 효과는 값에 따라 다릅니다.

• true: MP의 급증 비율 한도는 <Rate>를 동일한 포드의 현재 MP 수로 나눈 값입니다. 집계 한도는 (총 <Rate>개) 하원의원이 동적으로 추가 (또는 삭제)될 때 개별적으로 급증 비율 제한은 증가 (또는 감소)하지만 집계 제한은 동일하게 유지됩니다.
• false (생략된 경우 기본값): 각 MP의 급증 비율 한도는 단순히 <Rate>의 값입니다. 집계 한도는 모든 MP의 비율 합계입니다. 의원이 추가 (또는 제거)되면 개별 급증 비율 제한은 동일하게 유지되지만 총 제한은 증가 (또는 감소).

다음 표에서는 <UseEffectiveCount>가 각 MP:

이 예에서는 MP 수가 4에서 2로 감소하고 <UseEffectiveCount>이 (가) false인 경우 MP당 유효 요율은 동일하게 유지됩니다. 10페이지). 하지만 <UseEffectiveCount>가 true이면 MP당 유효 비율은 MP 수가 4에서 2로 감소하면 10에서 20으로 감소합니다.

흐름 변수

급증 저지 정책이 실행되면 다음과 같은 흐름 변수가 채워집니다.

자세한 내용은 흐름 변수 참조를 확인하세요.

오류 참조

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge 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.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Example error response

Shown below is an example error response:

{  
   "fault":{  
      "detail":{  
         "errorcode":"policies.ratelimit.SpikeArrestViolation"
      },
      "faultstring":"Spike arrest violation. Allowed rate : 10ps"
   }
}

Example fault rule

Shown below is an example fault rule to handle a SpikeArrestViolation fault:

<FaultRules>
    <FaultRule name="Spike Arrest Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "SpikeArrestViolation") </Condition>
        </Step>
        <Condition>ratelimit.Spike-Arrest-1.failed=true</Condition>
    </FaultRule>
</FaultRules>

할당량 또는 급증 저지 정책에서 설정한 비율 제한을 초과하는 경우에 관한 현재 HTTP 상태 코드 429 (너무 많은 요청)입니다. HTTP 상태 코드를 500로 변경하려면 내부 서버 오류가 발생함)에 대해 features.isHTTPStatusTooManyRequestEnabled 속성을 false로 조직 속성 업데이트 API

예를 들면 다음과 같습니다.

curl -u email:password -X POST -H "Content-type:application/xml" http://api.enterprise.apigee.com/v1/organizations/myorg -d \
"<Organization type="trial" name="MyOrganization">
    <Properties>
        <Property name="features.isHTTPStatusTooManyRequestEnabled">true</Property>
        . . .
    </Properties>
</Organization>"

스키마

각 정책 유형은 XML 스키마(.xsd)로 정의됩니다. 참고로 GitHub에서 정책 스키마를 사용할 수 있습니다.

관련 주제

• 할당량 정책: 개별 클라이언트의 트래픽을 제한하는 할당량 정책
• 비율 제한 개요의 비율 제한
• 할당량 및 SpikeArrest 정책
• API 프록시 작업 샘플