Vous pouvez créer et modifier des règles localement à l'aide de l'IDE ou l'éditeur de texte ou de fichiers XML de votre choix.
Cet article utilise le type de règle de quota comme exemple pour créer, configurer, associer, déployer et tester des règles.
La plupart des proxys d'API appliquent un quota. Les quotas permettent de contrôler la fréquence à laquelle une application cliente est autorisée à appeler une API au cours d'un intervalle de temps donné. Dans l'exemple ci-dessous, une règle de quota est configurée pour limiter les applications à une requête par minute (bien que cela ne soit pas toujours réaliste, cela offre un moyen simple de visualiser les effets d'une règle).
Dans une configuration de proxy d'API, les fichiers de règle sont stockés sous forme de fichiers XML dans le répertoire /apiproxy/policies.
Par exemple, une règle de type quota appelée "QuotaPolicy" peut être créée sous la forme d'un fichier nommé QuotaPolicy.xml avec le contenu suivant :
Vous pouvez créer manuellement un fichier texte ou générer la règle à partir d'un schéma XML. Toutes les règles ont certains paramètres propres au type de règle, et d'autres qui sont génériques pour toutes les règles.
Lorsque vous associez des règles dans l'UI de gestion, le compilateur de proxy d'API génère l'instance de règle à partir du schéma XML du type de règle que vous avez sélectionné. Par conséquent, il se peut que la configuration des règles contienne des éléments qui, par souci de clarté, ne sont pas toujours inclus dans la documentation.
Toutes les règles définissent les attributs suivants :
enabled : indique si la règle est activée ou désactivée. Vous pouvez activer ou désactiver les règles lors de l'exécution en modifiant ce paramètre. Une règle dont l'attribut enabled est défini sur false n'est pas appliquée.
continueOnError : indique si le pipeline doit continuer à traiter le message en cas d'échec de la règle. Lors de l'application des règles de quota, des erreurs indiquent probablement que le quota a été dépassé. Par conséquent, cet attribut doit être défini sur "false".
name : le nom que vous donnez à cette règle. Ce nom est unique à cette instance de règle et permet d'associer la règle au flux en tant qu'étape de traitement.
Dans l'exemple ci-dessus, les éléments Allow, Interval et TimeUnit sont spécifiques à la règle de quota. Ces éléments fournissent des paramètres que les services d'API appliquent au nom d'une API. Les autres types de règles définissent leurs propres paramètres. Vous pouvez obtenir plus d'informations dans la documentation de référence sur les règles.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/09/03 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Difficile à comprendre","hardToUnderstand","thumb-down"],["Informations ou exemple de code incorrects","incorrectInformationOrSampleCode","thumb-down"],["Il n'y a pas l'information/les exemples dont j'ai besoin","missingTheInformationSamplesINeed","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 2025/09/03 (UTC)."],[[["\u003cp\u003eThis guide focuses on creating, configuring, attaching, deploying, and testing policies within Apigee and Apigee hybrid environments.\u003c/p\u003e\n"],["\u003cp\u003ePolicies, exemplified here by the Quota policy, are stored as XML files in the \u003ccode\u003e/apiproxy/policies\u003c/code\u003e directory within an API proxy configuration.\u003c/p\u003e\n"],["\u003cp\u003eThe Quota policy type allows control over API invocation frequency, as illustrated by an example that limits apps to one request per minute.\u003c/p\u003e\n"],["\u003cp\u003eAll policies, including the Quota policy, have attributes such as \u003ccode\u003eenabled\u003c/code\u003e, \u003ccode\u003econtinueOnError\u003c/code\u003e, and \u003ccode\u003ename\u003c/code\u003e, which define their behavior and status.\u003c/p\u003e\n"],["\u003cp\u003ePolicy-specific elements like \u003ccode\u003eAllow\u003c/code\u003e, \u003ccode\u003eInterval\u003c/code\u003e, and \u003ccode\u003eTimeUnit\u003c/code\u003e in the Quota policy example provide settings for enforcing API limits.\u003c/p\u003e\n"]]],[],null,["# Attaching and configuring policies in XML files\n\n*This page\napplies to **Apigee** and **Apigee hybrid**.*\n\n\n*View [Apigee Edge](https://docs.apigee.com/api-platform/get-started/what-apigee-edge) documentation.*\n\nYou can create and edit policies locally, using your favorite text or XML-aware editor or IDE.\nThis topic uses the Quota policy type as an example of how to create, configure, attach, deploy,\nand test policies.\n\nMost API proxies enforce a quota. Quotas provide control over how often a client app is\npermitted to invoke an API over a given time interval. In the example below, a Quota policy is\nconfigured to limit apps to 1 request per minute. (While this may not be realistic, it does\nprovide a simple way to see the effects of a policy.)\n\nIn an API proxy configuration, Policy files are stored as XML files under\n`/apiproxy/policies` directory.\n\nFor example, a policy of type Quota called Quota Policy could be created as a file called\n`QuotaPolicy.xml` with the following content: \n\n```text\n\u003cQuota enabled=\"true\" continueOnError=\"false\" name=\"QuotaPolicy\"\u003e\n \u003cAllow count=\"1\"/\u003e\n \u003cInterval\u003e1\u003c/Interval\u003e\n \u003cTimeUnit\u003eminute\u003c/TimeUnit\u003e\n\u003c/Quota\u003e\n```\n\nYou can create a text file by hand, or you can generate the policy from an XML schema. All\npolicies have some settings that are specific to the policy type, and some settings that are\ngeneric across all policies. \nWhen you attach policies in the management UI, the API proxy builder generates the policy instance from the XML schema for the policy type you selected. Therefore, you may see elements in the policy configuration that, for clarity, are not always included in documentation.\n\nAll policies define the following attributes:\n\n- `enabled`: Indicates whether the policy is turned *on* or *off* . Policies can be enabled/disabled at runtime by changing this setting. A policy that has `enabled` set to `false` is not enforced.\n- `continueOnError`: Defines whether the pipeline should continue processing the message if the policy fails. When enforcing quota policies, errors likely indicate that the quota has been exceeded, and, therefore, this attribute should be set to false.\n- `name`: The name that you give to this policy. This name is unique to this policy instance, and it is used to attach the policy to the flow as a processing step.\n\n| **Note:** Except for `name`, you rarely need to modify the default settings for these policy attributes. For this reason, and for clarity, they are often excluded from the policy samples in the documentation.\n\nIn the example above, the elements `Allow`, `Interval`, and\n`TimeUnit` are specific to the Quota policy. These elements provide settings that API\nServices enforces on behalf of an API. Other policy types define their own settings, which you\ncan learn about in the [Policy Reference](/apigee/docs/api-platform/reference/policies/reference-overview-policy)."]]
