Todos os produtos
Search
Central de documentação

Edge Security Acceleration:CreateCacheRule

Última atualização: Jun 29, 2026

Cria uma configuração de cache de site.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

  • Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.

  • API: A API que você pode chamar para executar a ação.

  • Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.

  • Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.

    • Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.

    • Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.

  • Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.

  • Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

esa:CreateCacheRule

create

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

Nenhuma Nenhuma

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

SiteId

integer

Sim

O ID do site. Você pode chamar a operação ListSites para obter este ID.

340035003106221

SiteVersion

integer

Não

A versão da configuração do site. Para sites com o gerenciamento de versão ativado, este parâmetro especifica a versão do site à qual a configuração se aplica.

1

RuleName

string

Não

O nome da regra. Este parâmetro não é obrigatório para uma configuração global.

rule_example

RuleEnable

string

Não

Especifica se a regra deve ser ativada. Este parâmetro não é obrigatório para uma configuração global. Valores válidos:

  • on: Ativa a regra.

  • off: Desativa a regra.

on

Rule

string

Não

O conteúdo da regra, que é uma expressão condicional usada para corresponder às solicitações do usuário. Este parâmetro não é obrigatório para uma configuração global.

  • Para corresponder a todas as solicitações, defina o valor como true.

  • Para corresponder a solicitações específicas, defina o valor como uma expressão personalizada, como (http.host eq "video.example.com").

(http.host eq \"video.example.com\")

BypassCache

string

Não

O modo de bypass de cache. Valores válidos:

  • cache_all: Armazena em cache todas as solicitações.

  • bypass_all: Ignora o cache para todas as solicitações.

cache_all

BrowserCacheMode

string

Não

O modo de cache do navegador. Valores válidos:

  • no_cache: Desativa o cache do navegador.

  • follow_origin: Segue a política de cache do servidor de origem.

  • override_origin: Substitui a política de cache do servidor de origem.

follow_origin

BrowserCacheTtl

string

Não

O TTL do cache do navegador, em segundos.

300

EdgeCacheMode

string

Não

O modo de cache de borda. Valores válidos:

  • follow_origin: Segue a política de cache do servidor de origem, se existir; caso contrário, usa a política de cache padrão.

  • no_cache: Desativa o cache no nó de borda.

  • override_origin: Substitui a política de cache do servidor de origem.

  • follow_origin_bypass: Segue a política de cache do servidor de origem, se existir; caso contrário, o conteúdo não é armazenado em cache.

  • follow_origin_override: Segue a política de cache do servidor de origem, se existir; caso contrário, usa um TTL de cache de borda personalizado.

follow_origin

EdgeCacheTtl

string

Não

O TTL do cache de borda, em segundos.

300

EdgeStatusCodeCacheTtl

string

Não

O TTL do cache de código de status, em segundos.

  • Você pode definir o TTL do cache para um código de status específico. Por exemplo, 404=10 armazena em cache as respostas com o código de status 404 por 10 segundos.

  • Você pode definir o TTL do cache para uma série de códigos de status, como 4xx ou 5xx. Por exemplo, 4xx=10 armazena em cache todas as respostas que possuem um código de status na série 4xx por 10 segundos.

  • Você pode especificar vários TTLs de código de status, separados por vírgulas (,).

5xx=0,404=10

SortQueryStringForCache

string

Não

Especifica se as strings de consulta devem ser classificadas. Este recurso é desativado por padrão. Valores válidos:

  • on: Ativa a classificação.

  • off: Desativa a classificação.

on

QueryStringMode

string

Não

O modo para processar strings de consulta ao gerar uma chave de cache. Valores válidos:

  • ignore_all: Ignora todas as strings de consulta.

  • exclude_query_string: Exclui as strings de consulta especificadas.

  • reserve_all: Inclui todas as strings de consulta (o padrão).

  • include_query_string: Inclui apenas as strings de consulta especificadas.

reserve_all

QueryString

string

Não

As strings de consulta a serem incluídas ou excluídas da chave de cache. Separe várias strings de consulta com espaços.

example

IncludeHeader

string

Não

Os cabeçalhos a serem incluídos na chave de cache. Tanto os nomes dos cabeçalhos (não diferenciam maiúsculas de minúsculas) quanto seus valores são incluídos. Separe vários nomes de cabeçalho com espaços. Os nomes dos cabeçalhos podem conter os seguintes caracteres:

  • Símbolos: ! # $ % & ' * + - . ^ _ | ~

  • Dígitos: 0-9

  • Letras: a-z (minúsculas)

headername1 headername2

IncludeCookie

string

Não

Os cookies a serem incluídos na chave de cache. Tanto os nomes dos cookies (não diferenciam maiúsculas de minúsculas) quanto seus valores são incluídos. Separe vários nomes de cookies com espaços. Os nomes dos cookies podem conter os seguintes caracteres:

  • Símbolos: ! # $ % & ' * + - . ^ _ | ~

  • Dígitos: 0-9

  • Letras: a-z (minúsculas)

cookiename1 cookiename2

CacheReserveEligibility

string

Não

Especifica se as solicitações ignoram os nós de reserva de cache durante uma busca na origem. Valores válidos:

  • bypass_cache_reserve: A solicitação ignora a reserva de cache.

  • eligible_for_cache_reserve: A solicitação é elegível para reserva de cache.

bypass_cache_reserve

CheckPresenceHeader

string

Não

Especifica os cabeçalhos cuja presença deve ser verificada ao gerar uma chave de cache. Se um cabeçalho especificado estiver presente na solicitação, seu nome (não diferencia maiúsculas de minúsculas) será incluído na chave de cache. Para especificar vários cabeçalhos, separe seus nomes com espaços. Os nomes dos cabeçalhos podem conter os seguintes caracteres:

  • Símbolos: ! # $ % & ' * + - . ^ _ | ~

  • Dígitos: 0-9

  • Letras: a-z (minúsculas)

headername1 headername2

CheckPresenceCookie

string

Não

Especifica os cookies cuja presença deve ser verificada ao gerar uma chave de cache. Se um cookie especificado estiver presente na solicitação, seu nome (não diferencia maiúsculas de minúsculas) será incluído na chave de cache. Para especificar vários cookies, separe seus nomes com espaços. Os nomes dos cookies podem conter os seguintes caracteres:

  • Símbolos: ! # $ % & ' * + - . ^ _ | ~

  • Dígitos: 0-9

  • Letras: a-z (minúsculas)

cookiename1 cookiename2

UserDeviceType

string

Não

Especifica se o tipo de dispositivo cliente deve ser incluído na chave de cache. Valores válidos:

  • on: Inclui o tipo de dispositivo cliente.

  • off: Não inclui o tipo de dispositivo cliente.

on

UserGeo

string

Não

Especifica se a localização geográfica do cliente deve ser incluída na chave de cache. Valores válidos:

  • on: Inclui a localização geográfica.

  • off: Não inclui a localização geográfica.

on

UserLanguage

string

Não

Especifica se o idioma do cliente deve ser incluído na chave de cache. Valores válidos:

  • on: Inclui o idioma.

  • off: Não inclui o idioma.

on

ServeStale

string

Não

Especifica se o conteúdo obsoleto deve ser servido. Se ativado, um nó de borda pode servir conteúdo obsoleto (expirado) quando o servidor de origem estiver indisponível. Valores válidos:

  • on: Ativa o serviço de conteúdo obsoleto.

  • off: Desativa o serviço de conteúdo obsoleto.

on

AdditionalCacheablePorts

string

Não

  • Especifica portas adicionais nas quais o cache é ativado.

  • Valores válidos: 8880, 2052, 2082, 2086, 2095, 2053, 2083, 2087 e 2096.

  • Você pode especificar várias portas, separadas por vírgulas (,).

8880,2052,2086

CacheDeceptionArmor

string

Não

Especifica se a defesa contra engano de cache deve ser ativada. Este recurso ajuda a defender contra ataques de engano de cache da web. Quando este recurso está ativado, apenas o conteúdo que passa na validação é armazenado em cache. Valores válidos:

  • on: Ativa a defesa.

  • off: Desativa a defesa.

on

Sequence

integer

Não

A ordem de execução da regra. Um número menor indica uma prioridade maior.

1

PostCache

string

Não

Especifica se o cache de solicitações POST deve ser ativado.

on

PostBodySizeLimit

string

Não

O limite de tamanho para o corpo da solicitação ao usar o cache de solicitações POST, em KB. Os valores suportados variam de 1 a 8. Se não for especificado, o padrão é 8 KB.

1

PostBodyCacheKey

string

Não

Especifica como processar o corpo da solicitação ao gerar uma chave de cache para solicitações POST. Os seguintes modos são suportados:

  • md5: Calcula o hash MD5 do corpo da solicitação e adiciona o valor do hash à chave de cache.

  • ignore: Ignora o corpo da solicitação quando a chave de cache é gerada.

ignore

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

Objeto de resposta.

RequestId

string

O ID da solicitação.

04F0F334-1335-436C-A1D7-6C044FE73368

ConfigId

integer

O ID da configuração.

352816096987136

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368\n",
  "ConfigId": 352816096987136
}

Códigos de erro

Código de status HTTP

Código de erro

Mensagem de erro

Descrição

400 MissingParameter The specified ArgName is required for this function. When configuring a specific function, the required parameter is missing.
400 CanNotSetSequence Non-regular configuration, you cannot set Sequence parameters. Sequence parameters is not allowed in global configuration.
400 CacheReserveSiteExceedLimit The number of binding sites of the cache reserve instance exceeds the limit. The number of binding sites of a single cache reserve instance is limited. Please see the document for the limit. The number of sites for which the cache reserve instance bindings exceeds the limit.
400 CompileRuleError Rule compilation failed, please check the rule information passed in to ensure that the rule is written according to the syntax described in the document. Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.
400 SiteConfigLengthExceedLimit The overall configuration size of the site exceeds the limit, and the total size of all functional configurations of the site cannot exceed 512K. The size of the site configuration exceeds the limit, and the total size cannot exceed 512K.
400 ConfigConflicts Configuration conflicts, usually when multiple configurations are configured under the same function of the same site, such as duplicate rule names between multiple configurations. The parameter uniqueness check failed. Check for duplicate parameter values.
400 FunctionConflict The feature configuration conflicts. Sites with version management enabled cannot configure this feature. The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.
400 RuleRegexQuotaCheckFailed When configuring rules, rules with regular expressions are not allowed in this plan. Please check the relevant documentation of the plan or upgrade the plan. The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.
400 NestedRuleQuotaCheckFailed The nesting level of rules allowed by the plan failed to be verified. Please modify the nesting level of rules or upgrade the plan. The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.
400 ArgQuotaCheckFailed The passed-in parameter value failed to verify the validity of the plan. Please check the plan document to obtain the range of parameters that can be configured for the site plan. The current plan does not support the configuration of restricted parameters, please check the input parameters.
400 FunctionQuotaCheckFailed The quota verification for this function fails. It may be that the configuration of this function exceeds the limit of the site plan. Please check the plan introduction document corresponding to this site. The current plan does not support the configuration of restricted functions, please check the plan related function description.
400 ConfExceedLimit The number of function configurations exceeds the limit. Please check the interface document to see the number of configurations that can be supported by a single function. The number of configuration items for the current function has exceeded the upper limit set by the system.
400 ServiceInvokeFailed The call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details. Failed to call the service. Please try again later or contact customer service for details.
400 SpecifiedVersionReadOnly The specified version number is read-only and cannot be modified. The specified version number is read-only and cannot be modified.
400 VersionNotValid The site does not have version management enabled, or the version number passed in does not exist. The site does not have version management enabled, or the version number passed in does not exist.
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.ArgName Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation. Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.
400 InvalidParameter.ArgValue Invalid parameter value. Check whether the value format and length meet the requirements. Invalid parameter value. Check whether the value format and length meet the requirements.
400 InvalidParameter.Configs Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements. Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.
400 InstanceNotExist The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account. The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.
400 LockFailed The system is handling requests you previously submitted. Try again later. The system is handling requests you previously submitted. Try again later.
400 Instance.NotOnline Your plan is unavailable due to an overdue payment. Complete the payment first. Your plan is unavailable due to an overdue payment. Complete the payment first.
400 IllegalOperation.VersionManagement The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again. The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.
400 QuotaCheckFailed.VersionManagement Insufficient quota for version management. Contact technical support. Insufficient quota for version management. Contact technical support.
400 FunctionArgError Failed to check the configured function parameters. Failed to check the configured function parameters
404 SiteNotFound The website does not exist or does not belong to you. The website does not exist or does not belong to you.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.