Vincular y configurar políticas en archivos XML

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

Puedes crear y editar políticas de forma local con tu editor o IDE de texto o XML favorito. En este tema se usa el tipo de política Quota como ejemplo de cómo crear, configurar, adjuntar, desplegar y probar políticas.

La mayoría de los proxies de API aplican una cuota. Las cuotas permiten controlar la frecuencia con la que una aplicación cliente puede invocar una API en un intervalo de tiempo determinado. En el ejemplo siguiente, se ha configurado una política de cuotas para limitar las aplicaciones a una solicitud por minuto. Aunque puede que no sea realista, sí que ofrece una forma sencilla de ver los efectos de una política.

En una configuración de proxy de API, los archivos de políticas se almacenan como archivos XML en el directorio /apiproxy/policies.

Por ejemplo, se puede crear una política de tipo Quota llamada Quota Policy como un archivo llamado QuotaPolicy.xml con el siguiente contenido:

<Quota enabled="true" continueOnError="false" name="QuotaPolicy">
    <Allow count="1"/>
    <Interval>1</Interval>
    <TimeUnit>minute</TimeUnit>
</Quota>

Puede crear un archivo de texto manualmente o generar la política a partir de un esquema XML. Todas las políticas tienen algunos ajustes específicos del tipo de política y otros genéricos para todas las políticas.

Cuando adjuntas políticas en la interfaz de usuario de gestión, el creador de proxies de API genera la instancia de la política a partir del esquema XML del tipo de política que has seleccionado. Por lo tanto, es posible que veas elementos en la configuración de la política que, por motivos de claridad, no siempre se incluyen en la documentación.

Todas las políticas definen los siguientes atributos:

  • enabled: indica si la política está activada o desactivada. Las políticas se pueden habilitar o inhabilitar en tiempo de ejecución cambiando este ajuste. No se aplica una política que tenga enabled con el valor false.
  • continueOnError: define si la canalización debe seguir procesando el mensaje si la política falla. Al aplicar las políticas de cuota, es probable que los errores indiquen que se ha superado la cuota y, por lo tanto, este atributo debe tener el valor false.
  • name: el nombre que le asignes a esta política. Este nombre es único para esta instancia de la política y se usa para adjuntar la política al flujo como paso de procesamiento.

En el ejemplo anterior, los elementos Allow, Interval y TimeUnit son específicos de la política de cuota. Estos elementos proporcionan ajustes que los servicios de la API aplican en nombre de una API. Otros tipos de políticas definen sus propios ajustes, que puedes consultar en la referencia de políticas.