Chính sách của SpikeArrest

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

Chính sách Hạn chế tăng đột biến giúp ngăn chặn tình trạng lưu lượng truy cập tăng đột biến bằng phần tử <Rate>. Phần tử này điều tiết số lượng yêu cầu được proxy API xử lý và được gửi đến một phần phụ trợ, giúp bảo vệ chống lại độ trễ về hiệu suất và thời gian ngừng hoạt động.

Phần tử <SpikeArrest>

Xác định chính sách về Tăng đột biến.

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

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

Ví dụ

Dưới đây là một số ví dụ cho thấy một số cách mà bạn có thể áp dụng chính sách về việc Gia tăng đột biến:

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

Tham chiếu phần tử con

Phần này mô tả các phần tử con của <SpikeArrest>.

<DisplayName>

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

Phần tử <DisplayName> là phần tử 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.

<Identifier>

Cho phép bạn chọn cách nhóm các yêu cầu để có thể áp dụng chính sách Tăng đột biến dựa trên ứng dụng khách. Ví dụ: bạn có thể nhóm các yêu cầu theo mã nhà phát triển. Trong trường hợp đó, các yêu cầu của mỗi nhà phát triển sẽ được tính vào tỷ lệ Tăng đột biến của riêng họ chứ không phải tất cả các yêu cầu đến proxy.

Sử dụng kết hợp với phần tử <MessageWeight> để kiểm soát chi tiết hơn đối với chế độ điều tiết yêu cầu.

Nếu bạn để trống phần tử <Identifier>, một giới hạn tốc độ sẽ được áp dụng cho tất cả các yêu cầu gửi đến proxy 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>

Bảng sau đây mô tả các thuộc tính của <Identifier>:

Yếu tố này cũng được thảo luận trong bài đăng sau đây trên thẻ Cộng đồng Apigee: http://community.apigee.com/questions/2807/how-does-the-edge-quota-policy-work-when-no-identi.html.

<MessageWeight>

Chỉ định trọng số được xác định cho mỗi thông báo. Trọng số thông báo sẽ điều chỉnh tác động của một yêu cầu đối với việc tính toán tốc độ bắt giữ tăng đột biến. Trọng số thông báo có thể là bất kỳ biến luồng nào, chẳng hạn như tiêu đề HTTP, tham số truy vấn, tham số biểu mẫu hoặc nội dung nội dung thông báo. Bạn cũng có thể sử dụng biến tuỳ chỉnh bằng cách sử dụng chính sách JavaScript hoặc chính sách AttributionMessage.

Sử dụng kết hợp với <Identifier> để điều tiết thêm các yêu cầu của các ứng dụng hoặc ứng dụng cụ thể.

Ví dụ: nếu sự tăng đột biến <Rate> là 10pm và một ứng dụng gửi các yêu cầu có trọng số 2, thì ứng dụng đó chỉ được phép gửi 5 thông báo mỗi phút vì mỗi yêu cầu được tính là 2.

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

Bảng sau đây mô tả các thuộc tính của <MessageWeight>:

<Rate>

Chỉ định tốc độ để hạn chế mức tăng đột biến (hoặc hàng loạt) lưu lượng truy cập bằng cách đặt số lượng yêu cầu được cho phép tính theo phút hoặc theo giây. Bạn cũng có thể sử dụng phần tử này cùng với <Identifier> và <MessageWeight> để điều tiết lưu lượng truy cập một cách suôn sẻ trong thời gian chạy bằng cách chấp nhận các giá trị từ ứng dụng.

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

Bảng sau đây mô tả các thuộc tính của <Rate>:

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

<UseEffectiveCount>

Phân phối số lượng Tăng đột biến của bạn cho các Bộ xử lý tin nhắn (MP) khi sử dụng nhóm tự động cấp tài nguyên bổ sung.

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

Phần tử <UseEffectiveCount> là không bắt buộc. Giá trị mặc định là false khi phần tử này bị bỏ qua trong chính sách của bạn về việc Tăng đột biến.

Bảng sau đây mô tả các thuộc tính của phần tử <UseEffectiveCount>:

Tác động của <UseEffectiveCount> phụ thuộc vào giá trị của nó:

• true: Giới hạn tốc độ tăng đột biến của MP là <Rate> chia cho số MP hiện tại trong cùng một nhóm. Giới hạn tổng hợp là giá trị của <Rate>. Khi tệp MP được thêm (hoặc xoá) một cách linh động, hạn mức riêng lẻ về tốc độ tăng đột biến sẽ tăng (hoặc giảm), nhưng giới hạn tổng hợp sẽ vẫn giữ nguyên.
• false (đây là giá trị mặc định nếu bị bỏ qua): Giới hạn tốc độ tăng đột biến của mỗi MP chỉ là giá trị của <Rate>. Giới hạn tổng hợp là tổng tỷ lệ của tất cả các nghị sĩ. Khi thêm (hoặc xoá) MP, mức giới hạn riêng lẻ về tỷ lệ tăng đột biến sẽ không thay đổi, nhưng hạn mức tổng hợp sẽ tăng (hoặc giảm).

Bảng sau đây cho thấy ảnh hưởng của <UseEffectiveCount> đối với giới hạn tốc độ thực tế của từng MP:

Trong ví dụ này, hãy lưu ý rằng khi số lượng MP giảm từ 4 xuống 2 và <UseEffectiveCount> là false, thì tỷ lệ hiệu quả trên mỗi MP vẫn giữ nguyên (ở mức 10). Nhưng khi <UseEffectiveCount> là true, tỷ lệ hiệu quả trên mỗi MP sẽ tăng từ 10 lên 20 khi số lượng MP giảm từ 4 xuống 2.

Biến luồng

Khi chính sách Bắt giữ tăng đột biến thực thi, biến luồng sau đây sẽ được điền:

Để biết thêm thông tin, hãy xem Tài liệu tham khảo về biến luồng.

Tham chiếu lỗi

Phần này mô tả các mã lỗi và thông báo lỗi được trả về, cũng như các biến lỗi do Edge đặt khi chính sách này kích hoạt lỗi. Thông tin này đóng vai trò quan trọng trong việc phát triển các quy tắc lỗi để xử lý lỗi. Để tìm hiểu thêm, hãy xem bài viết Những điều bạn cần biết về lỗi chính sách và Xử lý lỗi.

Lỗi thời gian chạy

Những lỗi này có thể xảy ra khi thực thi chính sách.

Lỗi triển khai

Những lỗi này có thể xảy ra khi bạn triển khai proxy chứa chính sách này.

Biến lỗi

Các biến này được đặt khi xảy ra lỗi thời gian chạy. Để biết thêm thông tin, hãy xem Những điều bạn cần biết về lỗi chính sách.

Ví dụ về phản hồi lỗi

Dưới đây là ví dụ về phản hồi lỗi:

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

Ví dụ về quy tắc lỗi

Dưới đây là một ví dụ về quy tắc lỗi để xử lý lỗi SpikeArrestViolation:

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

Mã trạng thái HTTP hiện tại về việc vượt quá giới hạn tốc độ do chính sách Hạn mức hoặc Hạn chế tăng đột biến đặt ra là 429 (Quá nhiều yêu cầu). Để thay đổi mã trạng thái HTTP thành 500 (Lỗi máy chủ nội bộ), hãy đặt thuộc tính features.isHTTPStatusTooManyRequestEnabled thành false bằng cách sử dụng API Cập nhật các thuộc tính của tổ chức.

Ví dụ:

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

Giản đồ

Mỗi loại chính sách được xác định bằng một giản đồ XML (.xsd). Giản đồ chính sách có sẵn trên GitHub để bạn tham khảo.

Chủ đề có liên quan

• Chính sách về hạn mức: Chính sách về hạn mức để hạn chế lưu lượng truy cập trên các khách hàng cá nhân
• Rate-limiting (Giới hạn số lượng yêu cầu) để xem thông tin tổng quan về giới hạn tốc độ
• So sánh chính sách về Hạn mức và SpikeArrest
• Mẫu proxy hoạt động của API