Cache settings

As funções do azion/applications que criam, listam, leem, atualizam e excluem os cache settings de uma application.

Última atualização

Ver como Markdown Configurar agente

Estas funções do azion/applications criam, listam, leem, atualizam e excluem os cache settings de uma application. A application precisa ter uma origem antes: em uma application sem nenhuma, a API recusa o cache setting com HTTP error! Status: 400 - BAD REQUEST.

createCacheSetting

Cria um cache setting em uma application. A application precisa ter uma origem antes. Em uma application sem nenhuma, a API recusa o cache setting, e a função retorna error com a mensagem HTTP error! Status: 400 - BAD REQUEST.

TypeScript
01function createCacheSetting(params: {
02 applicationId: number;
03 data: ApiBaseCacheSettingPayload;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationResponse<AzionCacheSetting>>;
ParâmetroTipoObrigatórioDescrição
applicationIdnumberSimO ID da application.
dataApiBaseCacheSettingPayloadSimAs configurações do cache setting. name é obrigatório.
optionsAzionClientOptionsNãoOpções de requisição.

browser_cache_settings recebe honor, override ou ignore, e cdn_cache_settings recebe honor ou override. Com override, o exemplo também define o campo de TTL máximo correspondente, browser_cache_settings_maximum_ttl ou cdn_cache_settings_maximum_ttl.

Retorna data como o AzionCacheSetting criado, com o id dele.

Este exemplo é em JavaScript, porque o TypeScript rejeita valores de string para browser_cache_settings e cdn_cache_settings, cujos tipos são enums que o módulo não exporta:

JavaScript
01import { createCacheSetting } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04
05// Create a new cache setting
06const cacheSettingData = {
07 name: 'my-cache-setting',
08 browser_cache_settings: 'override',
09 browser_cache_settings_maximum_ttl: 3600,
10 cdn_cache_settings: 'override',
11 cdn_cache_settings_maximum_ttl: 7200,
12};
13
14const { data: newCacheSetting, error } = await createCacheSetting({ applicationId, data: cacheSettingData });
15
16if (error) {
17 console.error('Error creating cache setting:', error);
18} else {
19 console.log('Cache setting created successfully:', newCacheSetting.id, newCacheSetting.name, newCacheSetting.cdn_cache_settings_maximum_ttl);
20}

Saída:

Cache setting created successfully: 234567 my-cache-setting 7200

getCacheSettings

Lista os cache settings de uma application, uma página por vez.

TypeScript
01function getCacheSettings(params: {
02 applicationId: number;
03 params?: ApiListCacheSettingsParams;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationCollectionResponse<AzionCacheSetting>>;
ParâmetroTipoObrigatórioDescrição
applicationIdnumberSimO ID da application.
paramsApiListCacheSettingsParamsNãoPaginação: page e page_size. Deixe de fora sort e order: a API recusa os valores que o tipo declara para eles com um erro 400.
optionsAzionClientOptionsNãoOpções de requisição.

Retorna um AzionApplicationCollectionResponse cujo data.results contém objetos AzionCacheSetting.

TypeScript
01import { getCacheSettings } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04
05const { data: cacheSettings, error } = await getCacheSettings({
06 applicationId,
07 params: { page: 1, page_size: 20 },
08});
09
10if (error) {
11 console.error('Error listing cache settings:', error);
12} else {
13 console.log(`Found ${cacheSettings?.count} cache settings:`, cacheSettings?.results.map((c) => `${c.id} ${c.name}`));
14}

Saída:

Found 1 cache settings: [ '234568 my-other-cache-setting' ]

getCacheSetting

Retorna um cache setting de uma application pelo ID dele.

TypeScript
01function getCacheSetting(params: {
02 applicationId: number;
03 cacheSettingId: number;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationResponse<AzionCacheSetting>>;
ParâmetroTipoObrigatórioDescrição
applicationIdnumberSimO ID da application.
cacheSettingIdnumberSimO ID do cache setting.
optionsAzionClientOptionsNãoOpções de requisição.

Retorna data como um AzionCacheSetting.

TypeScript
01import { getCacheSetting } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04const cacheSettingId = 234567; // Replace with the actual cache setting ID
05
06const { data: cacheSetting, error } = await getCacheSetting({ applicationId, cacheSettingId });
07
08if (error) {
09 console.error('Error retrieving cache setting:', error);
10} else {
11 console.log('Cache setting details:', cacheSetting?.id, cacheSetting?.name, cacheSetting?.browser_cache_settings, cacheSetting?.cdn_cache_settings);
12}

Saída:

Cache setting details: 234567 my-cache-setting override override

updateCacheSetting

Envia em uma requisição PATCH os campos do cache setting que você passa.

TypeScript
01function updateCacheSetting(params: {
02 applicationId: number;
03 cacheSettingId: number;
04 data: ApiUpdateCacheSettingPayload;
05 options?: AzionClientOptions;
06}): Promise<AzionApplicationResponse<AzionCacheSetting>>;
ParâmetroTipoObrigatórioDescrição
applicationIdnumberSimO ID da application.
cacheSettingIdnumberSimO ID do cache setting a atualizar.
dataApiUpdateCacheSettingPayloadSimOs campos a mudar. Todo campo é opcional.
optionsAzionClientOptionsNãoOpções de requisição.

Retorna data como o AzionCacheSetting atualizado. Um payload sem campos de enum, como name e um TTL, passa na verificação de tipos do TypeScript.

TypeScript
01import { updateCacheSetting } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04const cacheSettingId = 234567; // Replace with the actual cache setting ID
05
06const { data: updatedCacheSetting, error } = await updateCacheSetting({
07 applicationId,
08 cacheSettingId,
09 data: { name: 'my-cache-setting-updated', cdn_cache_settings_maximum_ttl: 3600 },
10});
11
12if (error) {
13 console.error('Error updating cache setting:', error);
14} else {
15 console.log('Cache setting updated:', updatedCacheSetting?.name, updatedCacheSetting?.cdn_cache_settings_maximum_ttl);
16}

Saída:

Cache setting updated: my-cache-setting-updated 3600

deleteCacheSetting

Exclui um cache setting de uma application pelo ID dele.

TypeScript
01function deleteCacheSetting(params: {
02 applicationId: number;
03 cacheSettingId: number;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationResponse<void>>;
ParâmetroTipoObrigatórioDescrição
applicationIdnumberSimO ID da application.
cacheSettingIdnumberSimO ID do cache setting a excluir.
optionsAzionClientOptionsNãoOpções de requisição.

Uma exclusão bem-sucedida retorna error com a mensagem Expected JSON response, but got: , por isso o exemplo lê o cache setting de volta com getCacheSetting. Um erro 404 confirma a exclusão.

TypeScript
01import { deleteCacheSetting, getCacheSetting } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04const cacheSettingId = 234567; // Replace with the actual cache setting ID
05
06const { error: deleteError } = await deleteCacheSetting({ applicationId, cacheSettingId });
07
08// On success (HTTP 204) the envelope still carries an error, so confirm by reading it back
09const { error } = await getCacheSetting({ applicationId, cacheSettingId });
10if (error) {
11 console.log(`Cache setting ${cacheSettingId} deleted (read back: ${error.message})`);
12} else {
13 console.error('Error deleting cache setting:', deleteError);
14}

Saída:

Cache setting 234567 deleted (read back: HTTP error! Status: 404 - NOT FOUND)

Recursos relacionados

Azion Lib

Os módulos da Azion Lib e o pacote npm em que cada um é distribuído.

Applications

A autenticação do módulo, o envelope de resposta dele e os erros que as funções reportam.

Tipos de application

Os tipos de payload e de resposta que estas funções recebem e retornam.

Cache settings

O cache setting que uma application aplica, com os TTLs e a chave de cache dele.