Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về
Apigee X. thông tin
Định cấu hình cách xoá hoàn toàn các giá trị đã lưu vào bộ nhớ đệm khỏi bộ nhớ đệm.
Chính sách này nhằm mục đích sử dụng vào bộ nhớ đệm trong thời gian ngắn có mục đích chung. Chính sách này được sử dụng cùng với Chính sách Điền bộ nhớ đệm (để ghi các mục nhập) và chính sách Tra cứu bộ nhớ đệm (để đọc các mục nhập bộ nhớ đệm).
Để lưu phản hồi của tài nguyên phụ trợ vào bộ nhớ đệm, hãy xem Chính sách bộ nhớ đệm của phản hồi.
Tham chiếu phần tử
Phần sau đây liệt kê các phần tử mà bạn có thể thiết lập theo chính sách này.
<InvalidateCache async="false" continueOnError="false" enabled="true" name="policy-name"> <DisplayName>Policy Name</DisplayName> <CacheKey> <Prefix>prefix_string</Prefix> <KeyFragment ref="variable_reference"/> <KeyFragment>fragment_string</KeyFragment> </CacheKey> <!-- Omit this element if you're using the included shared cache. --> <CacheResource>cache_to_use</CacheResource> <Scope>scope_enumeration</Scope> <CacheContext> <APIProxyName>application_that_added_the_entry</APIProxyName> <ProxyName>proxy_for_which_data_was_cached</ProxyName> <TargetName>endpoint_for_which_data_was_cached</TargetName> </CacheContext> <PurgeChildEntries>true_to_purge_all_child_entries</PurgeChildEntries> </InvalidateCache>
Thuộc tính <InvalidateCache>
Bảng sau đây mô tả các thuộc tính chung cho tất cả phần tử mẹ của chính sách:
Thuộc tính | Nội dung mô tả | Mặc định | Sự hiện diện |
---|---|---|---|
name |
Tên nội bộ của chính sách. Giá trị của thuộc tính Nếu muốn, bạn có thể sử dụng phần tử |
Không áp dụng | Bắt buộc |
continueOnError |
Đặt thành Đặt thành |
false | Không bắt buộc |
enabled |
Đặt thành Đặt thành |
đúng | Không bắt buộc |
async |
Thuộc tính này không được dùng nữa. |
false | Không được dùng nữa |
Phần tử <DisplayName>
Sử dụng cùng với thuộc tính name
để gắn nhãn cho chính sách trong trình chỉnh sửa proxy giao diện người dùng quản lý bằng tên khác theo ngôn ngữ tự nhiên.
<DisplayName>Policy Display Name</DisplayName>
Mặc định |
Không áp dụng Nếu bạn bỏ qua phần tử này, thì giá trị thuộc tính |
---|---|
Sự hiện diện | Không bắt buộc |
Loại | Chuỗi |
Phần tử <CacheContext>/<APIProxyName>
Chỉ định tên của ứng dụng đã thêm mục nhập bộ nhớ đệm.
<APIProxyName>application_that_added_the_entry</APIProxyName>
Thuộc tính
Thuộc tính | Nội dung mô tả | Mặc định | Sự hiện diện | Loại |
---|---|---|---|---|
giới thiệu | Biến có tên ứng dụng. | Không áp dụng | Không bắt buộc | Chuỗi |
Phần tử <CacheContext>
Chỉ định cách tạo khoá bộ nhớ đệm khi giá trị phần tử Prefix
không được chỉ định hoặc để xoá các mục trong bộ nhớ đệm do một proxy API khác thêm vào.
<CacheContext> <APIProxyName ref="variable_name">application_that_added_the_entry</APIProxyName> <TargetName ref="variable_name">endpoint_for_which_data_was_cached</TargetName> <ProxyName ref="variable_name">proxy_for_which_data_was_cached</ProxyName> </CacheContext>
Dùng để tạo CacheKey. Bạn bắt buộc phải sử dụng giá trị của APIProxyName, ProxyName và TargetName khi không dùng tiền tố CacheKey (nghĩa là một tiền tố tuỳ chỉnh) để xoá các mục nhập bộ nhớ đệm do một proxy API khác thêm vào.
Phần tử <CacheKey>
Định cấu hình một con trỏ duy nhất đến một phần dữ liệu được lưu trữ trong bộ nhớ đệm.
<CacheKey> <Prefix>string</Prefix> <KeyFragment ref="variable_name" /> <KeyFragment>literal_string</KeyFragment> </CacheKey>
Mặc định: |
Không áp dụng |
Sự hiện diện: |
Bắt buộc |
Loại: |
Không áp dụng |
<CacheKey>
tạo tên của từng phần dữ liệu được lưu trữ trong bộ nhớ đệm.
Trong thời gian chạy, các giá trị <KeyFragment>
được thêm vào trước giá trị phần tử <Scope>
hoặc giá trị <Prefix>
. Ví dụ: các đoạn mã sau đây dẫn đến khoá bộ nhớ đệm của UserToken__apiAccessToken__
<value_of_client_id>:
<CacheKey> <Prefix>UserToken</Prefix> <KeyFragment>apiAccessToken</KeyFragment> <KeyFragment ref="request.queryparam.client_id" /> </CacheKey>
Bạn sẽ sử dụng phần tử <CacheKey>
cùng với <Prefix>
và <Scope>
. Để biết thêm thông tin, hãy xem bài viết Xử lý khoá bộ nhớ đệm.
Phần tử <CacheResource>
Chỉ định bộ nhớ đệm nơi lưu trữ thư.
Bỏ qua hoàn toàn phần tử này nếu chính sách này (cũng như các chính sách PopulateCache và LookupCache tương ứng) đang sử dụng bộ nhớ đệm dùng chung đi kèm.
<CacheResource>cache_to_use</CacheResource>
Mặc định: |
Không áp dụng |
Sự hiện diện: |
Không bắt buộc |
Loại: |
Chuỗi |
Để biết thêm thông tin về cách định cấu hình bộ nhớ đệm, hãy xem bài viết Tạo và chỉnh sửa bộ nhớ đệm của môi trường.
Phần tử <CacheKey>/<KeyFragment>
Chỉ định một giá trị cần đưa vào khoá bộ nhớ đệm, tạo một không gian tên để so khớp các yêu cầu với phản hồi đã lưu vào bộ nhớ đệm.
<KeyFragment ref="variable_name"/> <KeyFragment>literal_string</KeyFragment>
Mặc định: |
Không áp dụng |
Sự hiện diện: |
Không bắt buộc |
Loại: |
Không áp dụng |
Đây có thể là khoá (tên tĩnh mà bạn cung cấp) hoặc giá trị (tập hợp mục động bằng cách tham chiếu đến một biến). Tất cả mảnh đã chỉ định kết hợp (cộng với tiền tố) được nối với nhau để tạo khoá bộ nhớ đệm.
<KeyFragment>apiAccessToken</KeyFragment> <KeyFragment ref="request.queryparam.client_id" />
Bạn sẽ sử dụng phần tử <KeyFragment>
cùng với <Prefix>
và <Scope>
. Để biết thêm thông tin, hãy xem bài viết Xử lý khoá bộ nhớ đệm.
Thuộc tính
Thuộc tính | Nội dung mô tả | Mặc định | Sự hiện diện | Loại |
---|---|---|---|---|
giới thiệu | Biến được dùng để nhận giá trị. Bạn không nên sử dụng nếu phần tử này chứa một giá trị cố định. | Không áp dụng | Không bắt buộc | Chuỗi |
Phần tử <CacheKey>/<Prefix>
Chỉ định một giá trị để dùng làm tiền tố khoá bộ nhớ đệm.
<Prefix>prefix_string</Prefix>
Mặc định: |
Không áp dụng |
Sự hiện diện: |
Không bắt buộc |
Loại: |
Chuỗi |
Hãy sử dụng giá trị này thay vì <Scope>
khi bạn muốn chỉ định giá trị của riêng mình thay vì giá trị liệt kê <Scope>
. Nếu được xác định, <Prefix>
sẽ thêm giá trị khoá bộ nhớ đệm cho các mục được ghi vào bộ nhớ đệm. Giá trị phần tử <Prefix>
ghi đè giá trị phần tử <Scope>
.
Bạn sẽ sử dụng phần tử <Prefix>
cùng với <CacheKey>
và <Scope>
. Để biết thêm thông tin, hãy xem bài viết Xử lý khoá bộ nhớ đệm.
Phần tử <CacheContext>/<ProxyName>
Chỉ định tên của proxy mà dữ liệu được lưu vào bộ nhớ đệm.
<ProxyName>proxy_for_which_data_was_cached</ProxyName>
Mặc định: |
Không áp dụng |
Sự hiện diện: |
Không bắt buộc |
Loại: |
Chuỗi |
Thuộc tính
Thuộc tính | Nội dung mô tả | Mặc định | Sự hiện diện | Loại |
---|---|---|---|---|
giới thiệu | Biến được dùng để nhận giá trị. Bạn không nên sử dụng nếu phần tử này chứa một giá trị cố định. | Không áp dụng | Không bắt buộc | Chuỗi |
Phần tử <PurgeChildEntries>
true
để xoá hoàn toàn các mục nhập bộ nhớ đệm có chung giá trị do phần tử <KeyFragment>
đặt được định cấu hình cho chính sách này. Những giá trị trong các phần khác của khoá bộ nhớ đệm, chẳng hạn như trong các phần tử <Prefix>
, sẽ không được xem xét.
Xin lưu ý rằng bạn phải chỉ định phần tử <KeyFragment>
. Nếu không, việc đặt giá trị true cho <PurgeChildEntries>
có thể dẫn đến việc xoá hoàn toàn tất cả các mục trong bộ nhớ đệm.
Việc vô hiệu hoá tất cả mục trong bộ nhớ đệm của cùng một giá trị mảnh khoá có thể là một cách hữu ích để xoá hoàn toàn nhiều mục liên quan cùng một lúc.
<PurgeChildEntries>true_to_purge_child_entries</PurgeChildEntries>
Mặc định: |
false |
Sự hiện diện: |
Không bắt buộc |
Loại: |
Boolean |
Phần tử <Scope>
Thuật toán liệt kê dùng để tạo tiền tố cho khoá bộ nhớ đệm khi phần tử <Prefix>
không được cung cấp trong phần tử <CacheKey>
.
<Scope>scope_enumeration</Scope>
Mặc định: |
"Độc quyền" |
Sự hiện diện: |
Không bắt buộc |
Loại: |
Chuỗi |
Chế độ cài đặt <Scope>
xác định khoá bộ nhớ đệm được thêm vào trước theo giá trị <Scope>
. Ví dụ: khoá bộ nhớ đệm sẽ có dạng như sau khi đặt phạm vi thành Exclusive
:
orgName__envName__ứng dụngName__deployedRevisionNumber__proxy|TargetName__ [ serializedCacheKey ].
Nếu có phần tử <Prefix>
trong <CacheKey>
, phần tử này sẽ thay thế giá trị phần tử <Scope>
. Giá trị hợp lệ bao gồm những giá trị liệt kê dưới đây.
Bạn sẽ sử dụng phần tử <Scope>
cùng với <CacheKey>
và <Prefix>
. Để biết thêm thông tin, hãy xem bài viết Xử lý khoá bộ nhớ đệm.
Giá trị được chấp nhận
Giá trị phạm vi | Nội dung mô tả |
---|---|
Global |
Khoá bộ nhớ đệm được dùng chung trên tất cả các proxy API được triển khai trong môi trường. Khoá bộ nhớ đệm được thêm vào trước dạng orgName __ envName __. Nếu bạn xác định một mục nhập |
Application |
Tên proxy API được dùng làm tiền tố. Khoá bộ nhớ đệm được thêm vào trước trong biểu mẫu orgName__envName__applicationName. |
Proxy |
Cấu hình ProxyEndpoint được dùng làm tiền tố. Khoá bộ nhớ đệm được thêm vào trước trong biểu mẫu orgName__envName__ứng dụngName__deployedRevisionNumber__proxyEndpointName . |
Target |
Cấu hình TargetEndpoint được dùng làm tiền tố. Khoá bộ nhớ đệm được thêm vào trước trong biểu mẫu orgName__envName__ứng dụngName__deployedRevisionNumber__targetEndpointName . |
Exclusive |
Mặc định. Đây là chỉ số cụ thể nhất và do đó có nguy cơ tối thiểu xảy ra xung đột không gian tên trong một bộ nhớ đệm nhất định. Tiền tố là một trong hai dạng:
Khoá bộ nhớ đệm được thêm vào trước trong dạng orgName__envName__ứng dụngName__ImplementationedRevisionNumber__proxyNameITargetName Ví dụ: chuỗi đầy đủ có thể có dạng như sau: apifactory__test__weatherapi__16__default__apiAccessToken. |
Phần tử <CacheContext>/<TargetName>
Chỉ định tên của điểm cuối đích mà dữ liệu được lưu vào bộ nhớ đệm.
<TargetName>endpoint_for_which_data_was_cached</TargetName>
Mặc định: |
Không áp dụng |
Sự hiện diện: |
Không bắt buộc |
Loại: |
Chuỗi |
Thuộc tính
Thuộc tính | Nội dung mô tả | Mặc định | Sự hiện diện | Loại |
---|---|---|---|---|
giới thiệu | Biến được dùng để nhận giá trị. Bạn không nên sử dụng nếu phần tử này chứa một giá trị cố định. | Không áp dụng | Không bắt buộc | Chuỗi |
Lưu ý về cách sử dụng
Lưu vào bộ nhớ đệm cho mục đích chung thông qua chính sách Điền bộ nhớ đệm, chính sách Tra cứu và
chính sách InvalidateCache sẽ sử dụng bộ nhớ đệm mà bạn định cấu hình hoặc bộ nhớ đệm dùng chung được đưa vào theo mặc định. Trong hầu hết các trường hợp, bộ nhớ đệm dùng chung cơ bản sẽ đáp ứng nhu cầu của bạn. Để sử dụng bộ nhớ đệm này,
bạn chỉ cần bỏ qua phần tử <CacheResource>
.
Để biết thêm thông tin về cách định cấu hình bộ nhớ đệm, hãy xem bài viết Tạo và chỉnh sửa bộ nhớ đệm của môi trường. Để biết thêm về kho dữ liệu cơ bản, hãy xem phần Bộ nhớ đệm nội bộ.
Mã lỗi
Phần này mô tả các thông báo lỗi và biến luồng được thiết lập khi chính sách này kích hoạt lỗi. Thông tin này rất quan trọng mà bạn cần biết nếu đang phát triển các quy tắc lỗi cho một proxy. Để 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.
Tiền tố mã lỗi
Không áp dụng
Lỗi thời gian chạy
Chính sách này không gửi bất kỳ lỗi thời gian chạy nào.
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.
Tên lỗi | Nguyên nhân | Khắc phục |
---|---|---|
InvalidCacheResourceReference |
Lỗi này xảy ra nếu phần tử <CacheResource> trong chính sách InvalidateCache được đặt thành tên không tồn tại trong môi trường nơi proxy API đang được triển khai. |
build |
CacheNotFound |
Lỗi này xảy ra nếu bộ nhớ đệm cụ thể được đề cập trong thông báo lỗi chưa được tạo trên một thành phần cụ thể của Trình xử lý thông báo. | build |
Biến lỗi
Không áp dụng
Ví dụ về phản hồi lỗi
Không áp dụng