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 về việc Bắt giữ tăng đột biến bảo vệ khỏi tình trạng lưu lượng truy cập tăng đột biến bằng phần tử <Rate>. Chiến dịch này phần tử điều tiết số lượng yêu cầu được một proxy API xử lý và được gửi tới một phần phụ trợ, giúp bảo vệ chống lại trễ hiệu suất và thời gian ngừng hoạt động.

<SpikeArrest> phần tử

Xác định Chính sách bắt giữ 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ụ

Các ví dụ sau đây trình bày một số cách mà bạn có thể sử dụng Chính sách về việc bắt giữ 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 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 nào.

<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 Bắt giữ tăng đột biến dựa trên trên máy 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 đó, mỗi yêu cầu các yêu cầu của nhà phát triển sẽ được tính vào tỷ lệ Bắt giữ tăng đột biến của chính họ và không phải tất cả các yêu cầu đối với proxy.

Sử dụng cùng với phần tử <MessageWeight> để chi tiết hơn quyền kiểm soát đối với việc điều tiết yêu cầu.

Nếu bạn để trống phần tử <Identifier>, hệ thống sẽ áp dụng một giới hạn tốc độ cho tất cả yêu cầu vào 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. Thay đổi trọng số thư sửa đổi mức độ tác động về một yêu cầu tính toán Tỷ lệ gia tăng tăng đột biến. Độ đậm của thư có thể là bất kỳ biến luồng, chẳng hạn như tiêu đề HTTP, tham số truy vấn, tham số biểu mẫu hoặc nội dung thư. Bạn cũng có thể sử dụng các biến tùy chỉnh bằng cách sử dụng chính sách JavaScript hoặc Chính sách assignMessage.

Sử dụng cùng với <Identifier> để điều tiết thêm các yêu cầu bằng cách ứng dụng khách hoặc ứng dụng cụ thể.

Ví dụ: nếu Spike Bắt giữ <Rate> là 10pm và một ứng dụng gửi các yêu cầu có trọng số là 2, thì chỉ được phép gửi năm tin nhắn mỗi phút từ khách hàng đó 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 độ giới hạn mức tăng đột biến (hoặc cụm) lưu lượng truy cập bằng cách đặt số lượng được phép theo khoảng thời gian mỗi phút hoặc mỗi giây. Bạn cũng có thể sử dụng phần tử này trong kết hợp với <Identifier> và <MessageWeight> để điều tiết trơn tru lưu lượng truy cập trong thời gian chạy bằng cách 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 đối với các Bộ xử lý tin nhắn (MP) khi sử dụng phương thức tự động cấp tài nguyên bổ sung nhóm.

<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ử bị bỏ qua trong chính sách về việc Bắt giữ tăng đột biến.

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

Hiệu ứ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ị trong tổng số <Rate>. Khi số lượng MP được thêm vào (hoặc bị xóa) một cách linh động, thì từng mức tăng đột biến giới hạn số lượng yêu cầu sẽ tăng (hoặc giảm) nhưng hạn mức tổng hợp sẽ giữ nguyên.
• false (đây là giá trị mặc định nếu bỏ qua): Giới hạn tốc độ tăng đột biến của mỗi MP là chỉ đơn giản 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 MP. Khi thêm (hoặc xóa) các nghị sĩ, thì giới hạn tỷ lệ tăng đột biến riêng lẻ của họ sẽ giữ nguyên, nhưng tổng hạn mức sẽ tăng lên (hoặc giảm).

Bảng sau đây trình bày tác động của <UseEffectiveCount> đến giới hạn tốc độ hiệu quả của mỗi MP:

Trong ví dụ này, chú ý rằng khi số MP giảm từ 4 xuống 2 và <UseEffectiveCount> là false, tốc độ 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ẽ thay đổi từ 10 đến 20 khi số lượng MP giảm từ 4 xuống 2.

Biến luồng

Khi thực thi Chính sách về việc giam giữ tăng đột biến, biến luồng sau sẽ được điền sẵn:

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

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 rất quan trọng nếu bạn đang phát triển các quy tắc lỗi để xử lý lỗi. Để tìm hiểu thêm, hãy xem 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 chính sách này thực thi.

Lỗi triển khai

Những lỗi này có thể xảy ra khi bạn triển khai proxy có 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 bài viết Những điều bạn cần biết về lỗi chính sách.

Ví dụ về phản hồi khi gặp 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à 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ượt quá giới hạn tốc độ do chính sách Hạn mức hoặc chính sách Bắt giữ 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ộ), đặt giá trị từ thuộc tính features.isHTTPStatusTooManyRequestEnabled đến false bằng cách sử dụng API Cập nhật 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 để tham khảo đều có trên GitHub.

Chủ đề có liên quan

• Chính sách về hạn mức: 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
• Giới hạn giá đối với giới hạn số lượng yêu cầu tổng quan
• So sánh Chính sách về hạn mức và SpikeArrest
• Mẫu hoạt động của proxy API