É possível criar e editar políticas localmente usando seu editor de texto ou com reconhecimento de XML favorito.
Este tópico usa o tipo de política de cota como um exemplo de como criar, configurar, anexar, implantar e testar políticas.
A maioria dos proxies de API impõe uma cota. As cotas fornecem controle sobre a frequência com que um app cliente pode invocar uma API em um determinado intervalo de tempo. No exemplo abaixo, uma política de cota foi configurada para limitar os apps a uma solicitação por minuto. Isso pode não ser realista, mas apresenta uma maneira simples de ver os efeitos de uma política.
Em uma configuração de proxy de API, os arquivos da política são armazenados como arquivos XML no diretório /apiproxy/policies.
Por exemplo, uma política do tipo Cota chamada Política de cotas poderia ser criada como um arquivo chamado
QuotaPolicy.xml com o seguinte conteúdo:
É possível criar um arquivo de texto manualmente ou gerar a política com base em um esquema XML. Todas as políticas têm algumas configurações específicas ao tipo de política, e algumas configurações que são genéricas em todas as políticas.
Quando você anexa políticas na IU de gerenciamento, o criador de proxy de API gera a instância de política com base no esquema XML para o tipo de política selecionado. Portanto, você pode ver os elementos na configuração da política que, por motivo de clareza, nem sempre estão incluídos na documentação.
Todas as políticas definem os seguintes atributos:
enabled: indica se a política está ativada ou desativada. As políticas podem ser
ativadas/desativadas no ambiente deexecução, alterando essa configuração. Uma política que tenha enabled
definido como false não é aplicada.
continueOnError: define se o pipeline continuará a processar a mensagem se a política falhar. Ao aplicar políticas de cota, os erros provavelmente indicam que a cota foi excedida e, portanto, esse atributo precisa ser definido como falso.
name: o nome dado à política. Esse nome é exclusivo para essa instância da política e é usado para anexar a política ao fluxo como uma etapa de processamento.
No exemplo acima, os elementos Allow, Interval e TimeUnit são específicos da política de cota. Esses elementos fornecem as configurações que os Serviços da API aplicam em nome de uma API. Outros tipos de políticas definem as próprias configurações, que podem ser vistas na Referência da política.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-09-04 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)."]]
