slb template cache¶

RAM caching template

cache Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name cache-list

Collection URI /axapi/v3/slb/template/cache

Element Name cache

Element URI /axapi/v3/slb/template/cache/{name}

Element Attributes cache_attributes

Partition Visibility shared

Schema cache schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/slb/template/cache	cache attributes
POST /axapi/v3/slb/template/cache/ Payload: { "cache": { "name": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/slb/template/cache	cache attributes
Get Object	GET	/axapi/v3/slb/template/cache/{name}	cache attributes
GET /axapi/v3/slb/template/cache/a Reponse: { "cache": { "name": "a", "accept-reload-req": 0, "age": 3600, "default-policy-nocache": 0, "disable-insert-age": 0, "disable-insert-via": 0, "max-cache-size": 80, "min-content-size": 512, "max-content-size": 81920, "remove-cookies": 0, "replacement-policy": "LFU", "verify-host": 0, "uuid": "bf554468-505d-11ee-98ee-fbe362803b33", "user-tag": "a", "a10-url": "/axapi/v3/slb/template/cache/a" } }
Get List	GET	/axapi/v3/slb/template/cache	cache-list
Modify Object	POST	/axapi/v3/slb/template/cache/{name}	cache attributes
Replace Object	PUT	/axapi/v3/slb/template/cache/{name}	cache attributes
PUT /axapi/v3/slb/template/cache/a Payload: { "cache": { "name": "a", "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/slb/template/cache	cache-list
Delete Object	DELETE	/axapi/v3/slb/template/cache/{name}	cache attributes
DELETE /axapi/v3/slb/template/cache/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

cache-list¶

cache-list is JSON List of cache attributes

cache-list : [

{ cache attributes },

{ cache attributes },

…

]

cache attributes¶

accept-reload-req

Description Accept reload requests via cache-control directives in HTTP headers

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

age

Description Specify duration in seconds cached content valid, default is 3600 seconds (seconds that the cached content is valid (default 3600 seconds))

Type: number

Range: 1-999999

Default: 3600

default-policy-nocache

Description Specify default policy to be to not cache

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

disable-insert-age

Description Disable insertion of age header in response served from RAM cache

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

disable-insert-via

Description Disable insertion of via header in response served from RAM cache

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

local-uri-policy

Type: List

logging

Description Specify logging template (Logging Config name)

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/slb/template/logging

max-cache-size

Description Specify maximum cache size in megabytes, default is 80MB (RAM cache size in megabytes (default 80MB))

Type: number

Range: 1-4096

Default: 80

max-content-size

Description Maximum size (bytes) of response that can be cached - default 81920 (80KB)

Type: number

Range: 0-268435455

Default: 81920

min-content-size

Description Minimum size (bytes) of response that can be cached - default 512

Type: number

Range: 0-268435455

Default: 512

name

Description Specify cache template name

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

packet-capture-template

Description Name of the packet capture template to be bind with this object

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/visibility/packet-capture/object-templates/slb-templ-cache-tmpl

remove-cookies

Description Remove cookies in response and cache

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

replacement-policy

Description ‘LFU’: LFU;

Type: string

Supported Values: LFU

Default: LFU

sampling-enable

Type: List

uri-policy

Type: List

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

verify-host

Description Verify request using host before sending response from RAM cache

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

local-uri-policy¶

Specification Value

Type list

Block object keys

local-uri

Description Specify Local URI for caching (Specify URI pattern that the policy should be applied to, maximum 63 charaters)

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

sampling-enable¶

Specification Value

Type list

Block object keys

counters1

Description ‘all’: all; ‘hits’: Cache hits; ‘miss’: Cache misses; ‘bytes_served’: Bytes served from cache; ‘total_req’: Total requests received; ‘caching_req’: Total requests to cache; ‘nc_req_header’: slbTemplateCacheNcReqHeader, help nc_req_header; ‘nc_res_header’: slbTemplateCacheNcResHeader, help nc_res_header; ‘rv_success’: some help string; ‘rv_failure’: slbTemplateCacheRvFailure, help rv_failure; ‘ims_request’: some help string; ‘nm_response’: some help string; ‘rsp_type_CL’: some help string; ‘rsp_type_CE’: some help string; ‘rsp_type_304’: some help string; ‘rsp_type_other’: some help string; ‘rsp_no_compress’: some help string; ‘rsp_gzip’: some help string; ‘rsp_deflate’: some help string; ‘rsp_other’: some help string; ‘nocache_match’: some help string; ‘match’: some help string; ‘invalidate_match’: some help string; ‘content_toobig’: slbTemplateCacheContentToobig, help content_toobig; ‘content_toosmall’: slbTemplateCacheContentToosmall, help content_toosmall; ‘entry_create_failures’: slbTemplateCacheEntryCreateFailures, help entry_create_failures; ‘mem_size’: some help string; ‘entry_num’: some help string; ‘replaced_entry’: some help string; ‘aging_entry’: some help string; ‘cleaned_entry’: some help string; ‘rsp_type_stream’: some help string; ‘header_save_error’: some help string; ‘rsp_br’: rsp_br;

Type: string

Supported Values: all, hits, miss, bytes_served, total_req, caching_req, nc_req_header, nc_res_header, rv_success, rv_failure, ims_request, nm_response, rsp_type_CL, rsp_type_CE, rsp_type_304, rsp_type_other, rsp_no_compress, rsp_gzip, rsp_deflate, rsp_other, nocache_match, match, invalidate_match, content_toobig, content_toosmall, entry_create_failures, mem_size, entry_num, replaced_entry, aging_entry, cleaned_entry, rsp_type_stream, header_save_error, rsp_br

uri-policy¶

Specification Value

Type list

Block object keys

cache-action

Description ‘cache’: Specify if certain URIs should be cached; ‘nocache’: Specify if certain URIs should not be cached;

Type: string

Supported Values: cache, nocache

cache-value

Description Specify seconds that content should be cached, default is age specified in cache template

Type: number

Range: 1-999999

invalidate

Description Specify if URI should invalidate cache entries matching pattern (pattern that would match entries to be invalidated (64 chars max))

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

uri

Description Specify URI for cache policy (Specify URI pattern that the policy should be applied to, maximum 63 charaters)

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters