Consulta múltiplas configurações de cache.
Experimente agora
Testar
Autorização RAM
|
Ação |
Nível de acesso |
Tipo de recurso |
Chave de condição |
Ação dependente |
|
esa:ListCacheRules |
list |
*Site
|
Nenhuma | Nenhuma |
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| SiteId |
integer |
Sim |
O ID do site, que pode ser obtido chamando a operação ListSites. |
123456**** |
| ConfigId |
integer |
Não |
O ID da configuração. |
35281609698**** |
| ConfigType |
string |
Não |
O tipo de configuração. Você pode usar este parâmetro para consultar configurações globais ou de regras. Valores válidos:
Este parâmetro é opcional. Se você não especificar este parâmetro, tanto as configurações globais quanto as de regras serão retornadas. Valores válidos:
|
global |
| RuleName |
string |
Não |
O nome da regra. Você não precisa definir este parâmetro ao adicionar uma configuração global. |
test |
| PageNumber |
integer |
Não |
O número da página para uma consulta paginada. O valor deve ser maior ou igual a 1. |
1 |
| PageSize |
integer |
Não |
O número de entradas por página para uma consulta paginada. Valores válidos: 1 a 500. |
20 |
| SiteVersion |
integer |
Não |
O número da versão do site. Para sites com gerenciamento de versão habilitado, você pode usar este parâmetro para especificar a versão do site para a qual a configuração terá efeito. Valor padrão: 0. |
1 |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
Esquema da Resposta |
||
| RequestId |
string |
O ID da solicitação. |
36af3fcc-43d0-441c-86b1-428951dc8225 |
| Configs |
array<object> |
A lista de configurações no corpo da resposta. |
|
|
object |
|||
| ConfigId |
integer |
O ID da configuração. |
395386449776640 |
| SiteVersion |
integer |
O número da versão da configuração do site. Para sites com gerenciamento de versão de configuração habilitado, você pode usar este parâmetro para especificar a versão do site para a qual a configuração terá efeito. Valor padrão: 0. |
1 |
| Sequence |
integer |
A ordem de execução da regra. Um valor menor indica uma prioridade mais alta. |
1 |
| RuleEnable |
string |
O switch da regra. Você não precisa definir este parâmetro ao adicionar uma configuração global. Valores válidos:
|
on |
| Rule |
string |
O conteúdo da regra, que usa expressões condicionais para corresponder às solicitações dos usuários. Você não precisa definir este parâmetro ao adicionar uma configuração global. Dois cenários são suportados:
|
(http.host eq \"video.example.com\") |
| RuleName |
string |
O nome da regra. Você não precisa definir este parâmetro ao adicionar uma configuração global. |
rule_example |
| ConfigType |
string |
O tipo de configuração. Você pode usar este parâmetro para consultar configurações globais ou de regras. Valores válidos:
|
global |
| BypassCache |
string |
O modo de bypass de cache. Valores válidos:
|
cache_all |
| BrowserCacheMode |
string |
O modo de cache do navegador. Valores válidos:
|
no_cache |
| BrowserCacheTtl |
string |
O tempo de expiração do cache do navegador, em segundos. |
300 |
| EdgeCacheMode |
string |
O modo de cache de borda. Valores válidos:
|
follow_origin |
| EdgeCacheTtl |
string |
O tempo de expiração do cache de borda, em segundos. |
300 |
| EdgeStatusCodeCacheTtl |
string |
O tempo de expiração do cache por código de status, em segundos.
|
5xx=0,404=10 |
| SortQueryStringForCache |
string |
Especifica se as query strings devem ser ordenadas. Valores válidos:
|
on |
| QueryStringMode |
string |
O modo de tratamento de query strings ao gerar chaves de cache. Valores válidos:
|
ignore_all |
| QueryString |
string |
As query strings a serem retidas ou removidas ao gerar chaves de cache. Múltiplos valores são separados por espaços. |
example |
| IncludeHeader |
string |
Os nomes de cabeçalho especificados (não diferencia maiúsculas de minúsculas) e seus valores a serem incluídos ao gerar chaves de cache. Múltiplos valores são separados por espaços. Os nomes de cabeçalho suportam os seguintes tipos de caracteres:
|
headername1 headername2 |
| IncludeCookie |
string |
Os nomes de cookie especificados (não diferencia maiúsculas de minúsculas) e seus valores a serem incluídos ao gerar chaves de cache. Múltiplos valores são separados por espaços. Os nomes de cookie suportam os seguintes tipos de caracteres:
|
cookiename1 cookiename2 |
| CacheReserveEligibility |
string |
A elegibilidade para reserva de cache. Controla se as solicitações dos usuários ignoram o nó de reserva de cache durante o retorno à origem. Valores válidos:
|
bypass_cache_reserve |
| CheckPresenceHeader |
string |
Ao gerar chaves de cache, verifica se os cabeçalhos especificados existem. Se um cabeçalho existir, seu nome (não diferencia maiúsculas de minúsculas) é adicionado à chave de cache. Múltiplos nomes de cabeçalho são separados por espaços. Os nomes de cabeçalho suportam os seguintes tipos de caracteres:
|
headername1 headername2 |
| CheckPresenceCookie |
string |
Ao gerar chaves de cache, verifica se os cookies especificados existem. Se um cookie existir, seu nome (não diferencia maiúsculas de minúsculas) é adicionado à chave de cache. Múltiplos nomes de cookie são separados por espaços. Os nomes de cookie suportam os seguintes tipos de caracteres:
|
cookiename1 cookiename2 |
| UserDeviceType |
string |
Especifica se o tipo do cliente deve ser incluído ao gerar chaves de cache. Valores válidos:
|
on |
| UserGeo |
string |
Especifica se a localização geográfica do cliente deve ser incluída ao gerar chaves de cache. Valores válidos:
|
on |
| UserLanguage |
string |
Especifica se o tipo de idioma do cliente deve ser incluído ao gerar chaves de cache. Valores válidos:
|
on |
| ServeStale |
string |
Especifica se o cache expirado deve ser servido. Quando habilitado, os nós de borda podem responder às solicitações dos usuários com arquivos em cache expirados quando o servidor de origem está indisponível. Valores válidos:
|
on |
| AdditionalCacheablePorts |
string |
|
8880,2052,2086 |
| CacheDeceptionArmor |
string |
A proteção contra engano de cache. Protege contra ataques de engano de cache na web, armazenando em cache apenas conteúdo que passa pela validação. Valores válidos:
|
on |
| PostCache |
string |
Especifica se o cache POST deve ser habilitado. |
on |
| PostBodyCacheKey |
string |
O modo de tratamento da chave de cache para cache POST. Os dois modos a seguir são suportados:
|
ignore |
| PostBodySizeLimit |
string |
O limite de tamanho do corpo para cache POST. O valor é um número em KB. Valores válidos: 1 a 8. Se este parâmetro for deixado vazio, o valor padrão de 8 KB será aplicado. |
1 |
| PageNumber |
integer |
O número da página atual, que é o mesmo que o parâmetro de solicitação PageNumber. |
1 |
| PageSize |
integer |
O número de entradas por página. |
10 |
| TotalCount |
integer |
O número total de registros. |
20 |
| TotalPage |
integer |
O número total de páginas. |
2 |
Exemplos
Resposta de sucesso
JSON formato
{
"RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
"Configs": [
{
"ConfigId": 395386449776640,
"SiteVersion": 1,
"Sequence": 1,
"RuleEnable": "on",
"Rule": "(http.host eq \\\"video.example.com\\\")",
"RuleName": "rule_example",
"ConfigType": "global",
"BypassCache": "cache_all",
"BrowserCacheMode": "no_cache",
"BrowserCacheTtl": "300",
"EdgeCacheMode": "follow_origin",
"EdgeCacheTtl": "300",
"EdgeStatusCodeCacheTtl": "5xx=0,404=10",
"SortQueryStringForCache": "on",
"QueryStringMode": "ignore_all",
"QueryString": "example",
"IncludeHeader": "headername1 headername2",
"IncludeCookie": "cookiename1 cookiename2",
"CacheReserveEligibility": "bypass_cache_reserve",
"CheckPresenceHeader": "headername1 headername2",
"CheckPresenceCookie": "cookiename1 cookiename2",
"UserDeviceType": "on",
"UserGeo": "on",
"UserLanguage": "on",
"ServeStale": "on",
"AdditionalCacheablePorts": "8880,2052,2086",
"CacheDeceptionArmor": "on",
"PostCache": "on",
"PostBodyCacheKey": "ignore",
"PostBodySizeLimit": "1"
}
],
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 20,
"TotalPage": 2
}
Códigos de erro
|
Código de status HTTP |
Código de erro |
Mensagem de erro |
Descrição |
|---|---|---|---|
| 400 | InternalException | Failed to call the service. Try again later or contact technical support. | Failed to call the service. Try again later or contact technical support. |
| 400 | InvalidParameter.FunctionName | The specified feature does not exist. Specify a valid feature name based on the related documentation. | The specified feature does not exist. Specify a valid feature name based on the related documentation. |
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.