Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This policy uses Google Guava cache, which offers a map to send responses. The cache must be enabled through feature flags on the Snaplex.

You can confirm the following cache key types for the client:

  • Protocol

  • Host 

  • PAth Path 

  • Method

Headers/Query params supported

Hash Key SChe1 algorithm

Each key-value pair in the Response Cache Map will be:

Code Block
{
  policy_instance_id: Google Guava Cache,
  ...
}

...

  • HTTP Method

The policy supports using headers and query parameters to access the cache keys. The key is hashed with a SHA1 algorithm.


Each Cached HTTP Response contains the following information:

...

  • policy version to determine if the policy has been updated since the last save. An update to the policy will direct the flow to acquire a new HTTP response and overwrite the existing one.

Limitations

We do limit the The response cache to have a response less than the MAX_CACHE_BYTES which is a feature flag default to a value of 90000000 must be less than 9,0000,000 bytes which is equivalent to 85.83 MB (edited) . The policy always returns the response, but any data over the limit renders the payload incomplete.

Settings

Parameter Name

Description

Default Value

Label

Required. The name for the API policy.

HTTP Respone Cache

When this policy should be applied

An expression-enabled field that determines the condition to be fulfilled for the API policy to execute.

For example, if the value in this field is request.method == "POST", the API policy is executed only if the request method is a POST.

N/A

Cache Interval

The time period of the current cache before it is refreshed.

1

Time Unit

The time unit for the Cache Interval value.

Hour

Use HTTP Request Headers to Create Cache Keys

Enables the use of specific headers to identify a cache.

Unselected

Use HTTP Request Query Parameter to Create Cache Keys

Enables the use of query parameters to identify a cache.

Unselected

Status

Specifies whether the API policy is enabled or disabled. 

Enabled

...