Cache settings

Um cache setting é um conjunto de valores que dizem ao Cache como armazenar e entregar uma resposta. Ele pertence a uma Application, e os seus valores são o tempo de vida (TTL) de browser, o TTL e o comportamento de cache, o stale cache, a Large File Optimization, Tiered Cache e as variações de cache. Uma regra do Rules Engine com o behavior Set Cache Policy aplica o cache setting, e ele age apenas sobre as requisições às quais essa regra corresponde. Para criar um, consulte Crie um cache setting.

Interfaces

Seis interfaces criam e alteram o mesmo cache setting. As tabelas desta página nomeiam o controle do Console, o campo da API e a flag da CLI de cada campo.

O PUT substitui o cache setting inteiro, e o PATCH altera apenas os campos que envia. O endpoint de listagem filtra por id e name e pagina com page e page_size. A API autentica com um personal token no header Authorization: Token <token>. Para mais informações, consulte Personal tokens.

No azion.config.js, uma entrada AzionCache carrega name, stale, queryStringSort, tieredCache, methods, browser.maxAgeSeconds, edge.maxAgeSeconds, cacheByCookie e cacheByQueryString.

General

No Azion Console, a seção General do drawer Create Cache Settings carrega o nome. O name é o único campo que a API exige.

Browser Cache

O objeto browser_cache define o que o browser é instruído a guardar. No Azion Console, os seus controles ficam na seção Browser Cache.

honor mantém os headers Cache-Control e Expires enviados pela origem e os repassa ao browser. override substitui esses headers pelo TTL em browser_cache.max_age. Para no-cache, a opção No cache do Azion Console diz: “Disable browser caching to ensure content is always fetched directly from the server”. No azion update cache-setting, a flag de browser_cache.behavior é --browser-cache-settings.

Cache

O objeto modules.cache define por quanto tempo a Azion mantém uma cópia de uma resposta e o que faz com essa cópia. No Azion Console, os seus controles ficam na seção Cache.

honor mantém os headers Cache-Control e Expires enviados pela origem, e override os substitui pelo TTL em modules.cache.max_age. Quando a origem não envia nem Cache-Control nem Expires, honor mantém a cópia pelo Max Age do cache setting, modules.cache.max_age.

O stale cache, o campo stale_cache.enabled, permite que a Azion entregue uma cópia expirada por uma janela limitada quando a origem não responde. A Large File Optimization, o campo large_file_cache.enabled, armazena um objeto grande em fragmentos, e large_file_cache.offset carrega o tamanho deles, fixo em 1.024 kB. Tiered Cache é uma feature de Cache que adiciona uma segunda camada de cache entre o data center que responde a uma requisição e a sua origem. O tiered_cache.enabled a ativa para os objetos que esse cache setting coloca em cache, e o tiered_cache.topology seleciona onde essa camada os mantém. Um objeto tiered_cache enviado sem enabled ativa a camada. Para saber como cada um se comporta em uma requisição, consulte Expiração e atualização.

Application Accelerator

O objeto modules.application_accelerator guarda as variações de cache de um cache setting. No Azion Console, os seus quatro controles Cache vary by ficam na seção Application Accelerator, que o drawer Create Cache Settings mostra apenas enquanto Application Accelerator está ativo na Application. Enquanto Application Accelerator está desativado, a API recusa com o erro 21013 qualquer variação nesse objeto: um behavior diferente de ignore, ou um método em cache_vary_by_method. Um objeto que mantém esses padrões é aceito, mesmo com sort_enabled igual a true.

Juntos, os campos de modules.application_accelerator configuram Advanced Cache Key, uma feature de Application Accelerator. O cache_vary_by_devices usa os device groups definidos em Device Groups. Para saber o que cada behavior faz com a cache key, consulte Configurações do Application Accelerator.

No azion create cache-setting, a --enable-caching-for-options escreve options qualquer que seja o seu valor, e post exige --file. No azion update cache-setting, uma chamada que passa uma flag de método remove o outro método, então passe as duas flags para manter os dois.

ignore mantém a mesma key, quaisquer que sejam os valores, e all varia a key por todos os valores que chegam. allowlist varia a key pelos valores nomeados, e denylist varia a key por todos os valores exceto os nomeados. fields, cookie_names e device_group carregam os valores nomeados. sort_enabled agrupa os mesmos argumentos sob uma key, em qualquer ordem que cheguem. allowlist e denylist na query string exigem pelo menos um campo, ou a API retorna o erro 21018. Para os passos no Azion Console que configuram esses controles, consulte Configure a Advanced Cache Key para uma aplicação.

Corpo da requisição e comando da CLI

O corpo abaixo cria um cache setting completo pelo POST /v4/workspace/applications/{application_id}/cache_settings:

A API responde com HTTP 201, state igual a executed e o novo cache setting com o seu id em data:

O endpoint de listagem envolve os cache settings de uma Application em um envelope de página:

A CLI escreve pela linha de comando os campos cobertos por suas flags:

O comando imprime o id do novo cache setting:

No azion create cache-setting, as flags cobrem o browser cache, a variação por query string e por cookie e o cache de OPTIONS, e o azion update cache-setting também define sort_enabled e o cache de POST. Cada um dos outros campos é definido pelo --file com o corpo JSON: modules.cache.max_age, o comportamento de cache, o stale cache, a Large File Optimization e Tiered Cache.

Erros

A API responde cada requisição abaixo com HTTP 400. O corpo carrega o código, o título e um detalhe, e um erro de campo também aponta o campo.

O azion create cache-setting --tiered-caching-enabled true retorna 21001, porque a CLI só define o comportamento de cache pelo --file, então o cache setting mantém o padrão honor.

Limites

Os limites abaixo se aplicam a um cache setting. Cada linha nomeia a resposta da API além do valor.

O cache_vary_by_method aceita no máximo 2 valores. A API aceita apenas 1.024 em large_file_cache.offset. Para alterar o tamanho do fragmento, entre em contato com o time de Vendas. Para o tamanho de um objeto em cache e os limites de purge, consulte Limites de Applications.

Recursos relacionados