Adjunta y configura políticas en la IU

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

Consulta la documentación de Apigee Edge.

Agregar capacidades basadas en políticas a un proxy de API es un proceso de dos pasos:

1. Configura una instancia de un tipo de política
2. Adjunta la instancia de política a un flujo

En el siguiente diagrama, se muestra la relación entre las políticas y los flujos. Como puedes ver, una política se adjunta a un flujo como un paso de procesamiento. A fin de configurar el comportamiento deseado para tu API, debes comprender un poco sobre los flujos. (Este tema se explicó antes en Configura flujos).

Un tipo de política que se usa con frecuencia es la política SpikeArrest. SpikeArrest evita los aumentos repentinos en el tráfico de los mensajes que podrían saturar los servicios de backend.

Conecta una política a un flujo

Nota: Apigee presenta una versión nueva del Editor de proxies, que facilitará la edición de los proxies.

En las instrucciones de las dos primeras pestañas a continuación, se explica cómo usar el Editor de proxies nuevo o el clásico.

Editor de proxies nuevo

Para conectar una política a un flujo, haz lo siguiente:

1. Selecciona un proxy de API y navega a la vista Develop.
2. En el panel de la izquierda, haz clic en el botón + en la fila Políticas.

3. En laCrear política haz clic en elSelecciona un tipo de política y desplázate hacia abajo hastaAdministración del tráfico y seleccioneProtección contra aumentos de tráfico.

4. De manera opcional, puedes cambiar el Nombre visible y el Nombre de la política.

   

   Cuando hayas terminado, haz clic en Crear para crear la política.

5. Ahora que creaste la política de Spike Arrest, puedes agregarla a un paso en el PreFlow. Para hacerlo, selecciona Proxy Endpoints > default > PreFlow en el panel izquierdo:

   

6. Haz clic en el botón + junto a PreFlow en el panel Respuesta en la esquina inferior derecha del editor visual:

   

7. En el cuadro de diálogo Agregar paso de la política, selecciona la política Spike Arrest.

8. Haz clic en Agregar para adjuntar la política.

   La política de Spike Arrest se muestra en el panel Respuesta:

   

   El siguiente código XML para el proxy se muestra en el editor de texto:

   <ProxyEndpoint name="default">
     <PreFlow name="PreFlow">
       <Request/>
       <Response>
         <Step><
           <Name>SA-</Name>
         </Step>
       </Response>
     </PreFlow>
     <Flows/>
     <PostFlow name="PostFlow">
       <Request/>
       <Response/>
     </PostFlow>
     <HTTPProxyConnection>
       <BasePath>/myproxy</BasePath>
     </HTTPProxyConnection>
     <RouteRule name="default">
       <TargetEndpoint>default</TargetEndpoint>
     </RouteRule>
   </ProxyEndpoint>
     

Detaching policies from a flow

To detach a policy from a flow, click the three-dot menu next to the flow and select Delete policy step

Classic Proxy Editor

To attach a policy to a flow:

1. Select an API proxy and navigate to the Develop view.
2. In the API Proxy Editor, select the flow to which you want to attach a policy in the Navigator pane.
   For example, the PreFlow flow is selected for the default API proxy endpoint in the following figure:
   
3. In the Design view, click +Step associated with the request or response flow to attach a policy. For example:
   
   The Add Step dialog opens displaying a categorized list of policies.
   
4. Scroll and select the policy type that you want to attach to the selected flow.
5. Modify the following fields.

   • Display Name: Unique display name for the policy. The UI will generate a default name, but it is advisable to create a descriptive name for the policy. This will ensure that other developers in your organization have an easy time understanding what the policy is intended to do.

   • Name: Unique name for the policy. The policy name matches the display name with the following exceptions:

     • Spaces are replaced by dashes.

     • Consecutive dashes are replaced by a single dash.

     • Except for dashes, underscores, and spaces (which are replaced, as noted above), characters that are not alphanumeric, such as pound signs, percent signs, ampersands, and so on, are removed.

6. Click Add.

   The policy is attached to the selected flow.

After the policy is attached, you’ll see the policy displayed in the Designer view for the flow, in this example the PreFlow of the default proxy endpoint, and in the Policies list in the Navigation pane. The Code view, which displays the XML for the newly attached policy, displays below the Designer view. Apigee generates an instance of the policy that contains a set of reasonable default values.

Adding a policy without attaching it to a flow

To add a policy without attaching it to a flow, which is useful for Handling faults, click + in the Policies bar in the Navigator view to open the Add Policy dialog and add the policy (as described in steps 4 through 6 in the previous section).

A policy that is not attached to any flow is flagged with the detached icon in the Policies list, as shown adjacent to the API key message policy shown in the previous figure.

After you create the policy, you can attach it to a flow by dragging and dropping it from the Policies list to the desired flow in the Designer view.

Detaching policies from a flow

To detach a policy from a Flow, select the Flow. Mouse over the icon for the policy in the Designer view of the Flow. Click the X in the circle that appears in the icon.

Deleting a policy instance

To delete a policy instance, mouse over the entry for the policy in the Navigator view. Click the X in the circle that appears to the right of the entry.

Configuring policies in the UI

When the UI generates a policy instance, it applies reasonable default values for common settings. You may need to modify these settings to meet your requirements.

For example:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SpikeArrest async="false" continueOnError="false" enabled="true" name="spikearrest-1">
  <DisplayName>SpikeArrest-1</DisplayName>
  <FaultRules/>
  <Properties/>
  <Identifier ref="request.header.some-header-name"/>
  <MessageWeight ref="request.header.weight"/>
  <Rate>30ps</Rate>
</SpikeArrest>

Para configurar una política, edita directamente su configuración XML en la vista Code. Por ejemplo, la tasa máxima de mensajes para la política de Spike Arrest se establece inicialmente en 30 mensajes por segundo. Puedes cambiar la tasa máxima si cambias el valor del elemento <Rate> en el XML de la política. Para obtener más detalles sobre la configuración de políticas, consulta la Referencia de políticas.

También puede cortar y pegar políticas en la vista Code. Esta es una excelente manera de volver a usar las políticas de las muestras disponibles en GitHub.

Cuando realizas cambios en la definición de una política en la vista Code, los cambios se reflejan en Property Inspector. Lo contrario también es cierto: realiza cambios en Property Inspector y aparecerán en el XML, en la vista Code.

Si deseas ver la documentación específica de la política de cuotas que se usa en este tema, consulta Política de cuotas.

Usa la explicación del código de Gemini Code Assist con políticas

Vista previa — Gemini Code Assist policy code explain

Esta función está sujeta a las "Condiciones de las Ofertas de Fase Previa a la DG" de la sección Condiciones Generales del Servicio de las Condiciones Específicas del Servicio. Las funciones de fase previa a la DG están disponibles “tal cual” y podrían tener asistencia limitada. Para obtener más información, consulta las descripciones de la etapa de lanzamiento.

Si tienes Gemini Code Assist, puedes usarlo para comprender las políticas y los elementos de políticas directamente en la IU de Apigee en la consola de Cloud:

• Mientras editas la política en la vista Code, destaca parte del código de la política, como un elemento o atributo XML. También puedes destacar varios elementos.
• Haz clic en el ícono de Gemini Code Assist como se muestra a continuación. En el panel lateral, se muestra información sobre la política y el elemento que destacaste.
  Alerta: Si haces clic en el ícono de Gemini Code Assist, el texto destacado se enviará a Gemini en la consola de Google Cloud.