PurgeCaches - Edge Security Acceleration - Centre de documentation Alibaba Cloud

Actualise le contenu des fichiers sur les nœuds. Prend en charge l'actualisation par fichier, répertoire, balise de cache, paramètres ignorés, nom d'hôte et pour l'ensemble du site.

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:PurgeCaches

create

*Site.

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
SiteId	integer	Oui	L'identifiant du site, qui peut être obtenu en appelant l'opération ListSites.	123456789****
Type	string	Oui	Le type de nœud d'actualisation. Valeurs valides : file (par défaut) : actualisation de fichier. cachekey : actualisation de clé de cache. cachetag : actualisation d'étiquette de cache. directory : actualisation de dossier. ignoreParams : actualisation ignorant les paramètres. Cela consiste à supprimer le point d'interrogation (?) et tous les paramètres qui le suivent de l'URL de la requête. Lorsque vous soumettez une URL sans paramètres via cette opération d'API, l'URL soumise est comparée aux URL des ressources en cache une fois leurs paramètres supprimés. Si l'URL d'une ressource en cache correspond à l'URL soumise après la suppression des paramètres, le point de présence exécute l'actualisation sur la ressource en cache. hostname : actualisation de nom d'hôte. purgeall : actualise tout le contenu en cache sous le site. Valeurs valides : cachetag : Actualisation de balise de cache. hostname : Actualisation de nom d'hôte. file : Actualisation de fichier. cachekey : Actualisation de clé de cache. purgeall : Actualisation de tout le contenu en cache du site. ignoreparams : Actualisation avec paramètres ignorés. directory : Actualisation de répertoire.	file
Content	object	Non	Le contenu de l'actualisation.
Files	array	Non	La liste des fichiers à actualiser. Ce paramètre est requis lorsque Type est défini sur file.
	any	Non	La liste des fichiers à actualiser. Ce paramètre est requis lorsque Type est défini sur file. Remarque Un maximum de 1 000 entrées est autorisé par requête, avec un maximum de 10 noms de domaine différents.	["http://a.com/1.jpg?b=1", "http://a.com/2.jpg?b=1"]
CacheTags	array	Non	La liste des balises de cache à actualiser. Ce paramètre est requis lorsque Type est défini sur cachetag.
	string	Non	La liste des balises de cache à actualiser. Ce paramètre est requis lorsque Type est défini sur cachetag. Remarque Un maximum de 30 entrées est autorisé par requête.	["tag1", "tag2"]
Hostnames	array	Non	La liste des noms d'hôte à actualiser. Ce paramètre est requis lorsque Type est défini sur hostname.
	string	Non	La liste des noms d'hôte à actualiser. Ce paramètre est requis lorsque Type est défini sur hostname. Remarque Un maximum de 10 noms de domaine est autorisé par requête.	["a.com", "b.com"]
IgnoreParams	array	Non	La liste des fichiers avec paramètres ignorés. Ce paramètre est requis lorsque Type est défini sur ignoreParams.
	string	Non	La liste des fichiers avec paramètres ignorés. Ce paramètre est requis lorsque Type est défini sur ignoreParams. Remarque Un maximum de 100 entrées est autorisé par requête, avec un maximum de 10 noms de domaine différents.	["http://a.com/1.jpg", "http://a.com/2.jpg"]
Directories	array	Non	La liste des répertoires à actualiser. Ce paramètre est requis lorsque Type est défini sur directory.
	string	Non	La liste des répertoires à actualiser. Ce paramètre est requis lorsque Type est défini sur directory. Remarque Un maximum de 100 entrées est autorisé par requête, avec un maximum de 10 noms de domaine différents.	["http://a.com/path1/", "http://a.com/path2/"]
PurgeAll	boolean	Non	L'indicateur d'actualisation de l'ensemble du site. Valeur par défaut : false. Définissez ce paramètre sur true lorsque Type est défini sur purgeall.	true
CacheKeys	array<object>	Non	La liste des clés de cache à actualiser. Ce paramètre est requis lorsque Type est défini sur cachekey.
	array<object>	Non
Url	string	Non	L'URL à actualiser.	http://a.com/1.jpg?b=1
Headers	object	Non	Les informations d'en-tête correspondant à la clé de cache spécifiée lors de l'actualisation. Lorsque la fonctionnalité de clé de cache personnalisée est activée, la clé de cache est générée en fonction des en-têtes spécifiés pour l'actualisation. UserGeo : pays/région Les codes de pays/région suivent la norme ISO 3166-2. UserDeviceType : type d'appareil. Valeurs valides : desktop tablet mobile UserLanguage : langue Les codes de langue suivent la norme ISO 639-1 ou BCP 47. Par exemple, définissez cette valeur sur zh pour actualiser le contenu en chinois.
	string	Non	La valeur correspondant à l'en-tête de la clé de cache.	{"Url":"http://www.example.com/dog_picture.jpg","Headers":{"cat": "789", "Cookie": "test444=444;test333=333;test222=222", "UserGeo": "US", "UserDeviceType": "desktop","UserLanguage": "zh-CN"}}
Force	boolean	Non	Indique si les ressources du répertoire correspondant doivent être actualisées lorsque le contenu de retour à l'origine ne correspond pas aux ressources du serveur d'origine. Valeur par défaut : false. true : Actualise toutes les ressources sous le répertoire correspondant. false : Actualise uniquement les ressources modifiées sous le répertoire correspondant. Remarque Ce paramètre s'applique à l'actualisation de répertoire, à l'actualisation des balises de cache, à l'actualisation en ignorant les paramètres, à l'actualisation par nom d'hôte et à l'actualisation du cache de l'ensemble du site.	true
EdgeComputePurge	boolean	Non	Indique si les ressources en cache de calcul en périphérie doivent être actualisées. Par exemple, cela permet d'actualiser le contenu mis en cache par l'opération d'API Edge Routine CacheAPI à l'aide de fonctions de périphérie.	true

Éléments de réponse

Élément	Type	Description	Exemple
	object	Schéma de la réponse.
RequestId	string	L'identifiant de la requête.	ET5BF670-09D5-4D0B-BEBY-D96A2A528000
TaskId	string	L'identifiant de la tâche. Cet identifiant est renvoyé lorsque vous créez une tâche d'actualisation ou de préchargement.	15940956620

Exemples

JSON format

{
  "RequestId": "ET5BF670-09D5-4D0B-BEBY-D96A2A528000",
  "TaskId": "15940956620"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	Fournissez à la fois l'heure de début et l'heure de fin.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	L'heure de fin est antérieure à l'heure de début. Vérifiez les valeurs et réessayez.
400	DomainNameOverLimit	A maximum of 500 domains are supported for each request.	Un maximum de 500 noms de domaine sont pris en charge dans une seule requête. Réduisez le nombre de noms de domaine et réessayez.
400	InvalidTime	The query time cannot exceed the last 3 days.	La plage de temps de requête ne peut pas dépasser les 3 derniers jours.
400	MissingParameter.ObjectType	The ObjectType parameter is required if DomainName or ObjectType is specified.	Spécifiez le paramètre ObjectType.
400	InvalidStationParameter	The specified Station is invalid.	Le paramètre de nœud spécifié n'est pas valide.
400	TooManyRequests	Too many requests.Please try again later.	La charge du système fluctue. Réessayez plus tard.
400	InvalidTaskId.Malformed	The specified taskId is invalid.	L'identifiant de tâche spécifié n'est pas valide.
400	InvalidParameters.InvalidUrls	The specified urls are invalid.	Le paramètre URL dans la requête n'est pas valide.
400	QuotaExceeded	You attempts have exceeded the daily limit.	La limite du quota quotidien a été dépassée. Le quota de soumission pour aujourd'hui a été épuisé. Vous pouvez consulter le quota disponible restant pour aujourd'hui via l'API de quota.
400	InvalidParameter.RecordNotBelongToSite	The record name passed in does not belong to the current site.	Le nom d'enregistrement spécifié n'appartient pas au site actuel.
400	InvalidParameter.RecordNotProxied	The proxy is not turned on for the record name passed in.	L'enregistrement spécifié n'a pas le proxy activé.
400	InvalidParameter.SiteNotActivated	The site passed in is not activated.	Le site spécifié n'est pas activé.
429	TooManyRequests	System load fluctuates, please try again later.	La charge du système fluctue. Réessayez plus tard.

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

Notes de version

Consultez Notes de version pour la liste complète.