Tous les produits
Search
Centre de documentation

Edge Security Acceleration:GetCacheRule

Dernière mise à jour :Aug 07, 2026

Obtient une configuration de cache unique.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

  • Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.

  • API : l'API que vous pouvez appeler pour exécuter l'action.

  • Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.

  • Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.

    • Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.

    • Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.

  • Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.

  • Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

esa:GetCacheRule

get

*Site

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

Aucune Aucune

Paramètres de requête

Paramètre

Type

Requis

Description

Exemple

SiteId

integer

Oui

L'identifiant du site. Appelez l'opération ListSites pour obtenir cet identifiant.

123456****

ConfigId

integer

Oui

L'identifiant de la configuration. Appelez l'opération ListCacheRules pour obtenir cet identifiant.

352816096987136

Éléments de réponse

Élément

Type

Description

Exemple

object

Le schéma de la réponse.

RequestId

string

L'identifiant de la requête.

36af3fcc-43d0-441c-86b1-428951dc8225

ConfigId

integer

L'identifiant de la configuration.

352816096987136

ConfigType

string

Indique si la réponse contient une configuration globale ou une configuration de règle. Valeurs valides :

  • global : une configuration globale.

  • rule : une configuration de règle.

global

SiteVersion

integer

Le numéro de version de la configuration du site. Pour les sites dont la gestion des versions est activée, cela indique la version de la configuration. La valeur par défaut est 0.

1

Sequence

integer

L'ordre d'exécution de la règle. Une valeur plus petite indique une priorité plus élevée.

1

RuleEnable

string

Indique si la règle est activée. Ce paramètre s'applique uniquement aux configurations de règle. Valeurs valides :

  • on : activée.

  • off : désactivée.

on

Rule

string

Le contenu de la règle, qui est une expression conditionnelle utilisée pour faire correspondre les requêtes des utilisateurs. Ce paramètre s'applique uniquement aux configurations de règle.

  • Pour faire correspondre toutes les requêtes entrantes, utilisez true.

  • Pour faire correspondre des requêtes spécifiques, utilisez une expression personnalisée, telle que (http.host eq "video.example.com").

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

RuleName

string

Le nom de la règle. Ce paramètre s'applique uniquement aux configurations de règle.

rule_example

BypassCache

string

Indique s'il faut mettre en cache les requêtes ou contourner le cache. Valeurs valides :

  • cache_all : met en cache toutes les requêtes.

  • bypass_all : contourne le cache pour toutes les requêtes.

cache_all

BrowserCacheMode

string

Le mode de cache du navigateur. Valeurs valides :

  • no_cache : ne met pas en cache le contenu.

  • follow_origin : suit la stratégie de cache de l'origine.

  • override_origin : remplace la stratégie de cache de l'origine.

follow_origin

BrowserCacheTtl

string

Le TTL du cache du navigateur, en secondes.

300

EdgeCacheMode

string

Le mode de cache de périphérie. Valeurs valides :

  • follow_origin : utilise la stratégie de cache du serveur d'origine. Si aucune n'est fournie, la stratégie par défaut s'applique.

  • no_cache : ne met pas en cache le contenu.

  • override_origin : remplace la stratégie de cache de l'origine.

  • follow_origin_bypass : utilise la stratégie de cache du serveur d'origine. Si aucune n'est fournie, le contenu n'est pas mis en cache.

  • follow_origin_override : utilise la stratégie de cache du serveur d'origine. Si aucune n'est fournie, un TTL de cache personnalisé s'applique.

follow_origin

EdgeCacheTtl

string

Le TTL du cache de périphérie, en secondes.

300

EdgeStatusCodeCacheTtl

string

Le TTL du cache des codes d'état, en secondes.

  • Définissez le TTL du cache pour un code d'état spécifique. Par exemple, 404=10 indique que les réponses avec un code d'état 404 sont mises en cache pendant 10 secondes.

  • Définissez le TTL du cache pour les classes de codes d'état, telles que 4xx et 5xx. Par exemple, 4xx=10 indique que toutes les réponses avec un code d'état 4xx sont mises en cache pendant 10 secondes.

  • Séparez plusieurs entrées par des virgules.

5xx=0,404=10

SortQueryStringForCache

string

Indique s'il faut trier les chaînes de requête avant de générer la clé de cache. Valeurs valides :

  • on : activé.

  • off : désactivé.

on

QueryStringMode

string

Le mode de gestion des chaînes de requête lors de la génération d'une clé de cache. Valeurs valides :

  • ignore_all : ignore toutes les chaînes de requête.

  • exclude_query_string : exclut les chaînes de requête spécifiées.

  • reserve_all : conserve toutes les chaînes de requête. Il s'agit de la valeur par défaut.

  • include_query_string : inclut les chaînes de requête spécifiées.

reserve_all

QueryString

string

Spécifie les chaînes de requête à inclure dans la clé de cache ou à en exclure. Séparez plusieurs chaînes de requête par des espaces.

example

IncludeHeader

string

Spécifie les en-têtes à inclure dans la clé de cache. Les noms des en-têtes (insensibles à la casse) et leurs valeurs sont ajoutés à la clé. Séparez plusieurs noms d'en-tête par des espaces. Les noms d'en-tête peuvent contenir les caractères suivants :

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

  • Chiffres : 0-9

  • Lettres : lettres anglaises minuscules a-z

headername1 headername2

IncludeCookie

string

Spécifie les cookies à inclure dans la clé de cache. Les noms des cookies (insensibles à la casse) et leurs valeurs sont ajoutés à la clé. Séparez plusieurs noms de cookie par des espaces. Les noms de cookie peuvent contenir les caractères suivants :

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

  • Chiffres : 0-9

  • Lettres : lettres anglaises minuscules a-z

cookiename1 cookiename2

CacheReserveEligibility

string

L'éligibilité à la réserve de cache. Cela contrôle si une requête contourne le nœud de réserve de cache lors d'une requête vers l'origine. Valeurs valides :

  • bypass_cache_reserve : la requête contourne la réserve de cache.

  • eligible_for_cache_reserve : la requête est éligible à la réserve de cache.

bypass_cache_reserve

CheckPresenceHeader

string

Spécifie les en-têtes dont la présence est vérifiée lors de la génération d'une clé de cache. Si un en-tête spécifié existe dans la requête, son nom (insensible à la casse) est ajouté à la clé de cache. Séparez plusieurs noms d'en-tête par des espaces. Les noms d'en-tête peuvent contenir les caractères suivants :

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

  • Chiffres : 0-9

  • Lettres : lettres anglaises minuscules a-z

headername1 headername2

CheckPresenceCookie

string

Spécifie les cookies dont la présence est vérifiée lors de la génération d'une clé de cache. Si un cookie spécifié existe dans la requête, son nom (insensible à la casse) est ajouté à la clé de cache. Séparez plusieurs noms de cookie par des espaces. Les noms de cookie peuvent contenir les caractères suivants :

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

  • Chiffres : 0-9

  • Lettres : lettres anglaises minuscules a-z

cookiename1 cookiename2

UserDeviceType

string

Indique s'il faut inclure le type d'appareil du client dans la clé de cache. Valeurs valides :

  • on : activé.

  • off : désactivé.

on

UserGeo

string

Indique s'il faut inclure la localisation géographique du client dans la clé de cache. Valeurs valides :

  • on : activé.

  • off : désactivé.

on

UserLanguage

string

Indique s'il faut inclure la langue du client dans la clé de cache. Valeurs valides :

  • on : activé.

  • off : désactivé.

on

ServeStale

string

Indique s'il faut servir du contenu obsolète. Si cette option est activée, les nœuds de périphérie servent le contenu obsolète (expiré) depuis le cache lorsque le serveur d'origine n'est pas disponible. Valeurs valides :

  • on : activé.

  • off : désactivé.

on

AdditionalCacheablePorts

string

  • Ports supplémentaires sur lesquels la mise en cache est activée.

  • Valeurs valides : 8880, 2052, 2082, 2086, 2095, 2053, 2083, 2087, 2096.

  • Séparez plusieurs ports par des virgules.

8880,2052,2086

CacheDeceptionArmor

string

Indique s'il faut activer Cache Deception Armor. Cette fonctionnalité permet d'atténuer les attaques par tromperie de cache web en s'assurant que seul le contenu validé est mis en cache. Valeurs valides :

  • on : activé.

  • off : désactivé.

on

PostCache

string

Indique s'il faut activer la fonctionnalité de cache POST.

on

PostBodyCacheKey

string

Le mode de gestion du contenu du corps lors de la génération d'une clé de cache pour les requêtes POST. Valeurs valides :

  • md5 : calcule le hachage MD5 du contenu du corps et ajoute le hachage à la clé de cache.

  • ignore : ignore le contenu du corps dans la clé de cache.

ignore

PostBodySizeLimit

string

La limite de taille (en Ko) du contenu du corps pour la mise en cache POST. La valeur est un entier compris entre 1 et 8. Une valeur nulle ou vide correspond à 8 Ko par défaut.

1

Exemples

JSON format

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "ConfigId": 352816096987136,
  "ConfigType": "global",
  "SiteVersion": 1,
  "Sequence": 1,
  "RuleEnable": "on",
  "Rule": "(http.host eq \\\"video.example.com\\\")\n",
  "RuleName": "rule_example\n",
  "BypassCache": "cache_all",
  "BrowserCacheMode": "follow_origin",
  "BrowserCacheTtl": "300",
  "EdgeCacheMode": "follow_origin",
  "EdgeCacheTtl": "300",
  "EdgeStatusCodeCacheTtl": "5xx=0,404=10",
  "SortQueryStringForCache": "on",
  "QueryStringMode": "reserve_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"
}

Codes d'erreur

Code de statut HTTP

Code d'erreur

Message d'erreur

Description

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.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.