Referencia de configuración de agrupación de flujos compartidos

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

Consulta la documentación de Apigee Edge.

Un flujo compartido es una función reutilizable similar a un proxy de API. Para obtener más información, consulta el artículo Crear flujos compartidos reutilizables.

Estructura de directorios de la agrupación de flujos compartidos

La estructura de directorios del paquete de flujo compartido, que se muestra a continuación, es similar a la estructura de directorios de configuración de proxy de API.

Estructura de directorios de la agrupación de flujos compartidos

Una configuración de agrupación de flujos compartidos consta de lo siguiente:

Configuración base Ajustes de configuración principales.
Políticas Archivos de configuración con formato XML que cumplen los esquemas de políticas de Apigee.
Resources Secuencias de comandos, archivos JAR y archivos XSLT a los que hacen referencia las políticas para ejecutar lógica personalizada.
Flujos compartidos Flujos compartidos incluidos en este paquete.

Configuración base

El archivo de configuración base se encuentra en el directorio raíz del paquete. Su nombre es el nombre del paquete.

/sharedflowbundle/traffic-management-shared.xml

La configuración base define el contenido del paquete de flujo compartido, así como la información para hacer un seguimiento del historial de revisiones del paquete.

<SharedFlowBundle revision="2" name="traffic-management-shared">
    <ConfigurationVersion majorVersion="4" minorVersion="0"/>
    <CreatedAt>1478637529218</CreatedAt>
    <CreatedBy>gladys@example.com</CreatedBy>
    <Description>Shared flow to moderate API traffic</Description>
    <DisplayName>traffic-management-shared</DisplayName>
    <LastModifiedAt>1481573374023</LastModifiedAt>
    <LastModifiedBy>gladys@example.com</LastModifiedBy>
    <Policies>
        <Policy>Auth-Flow-Callout</Policy>
        <Policy>Extract-Token</Policy>
        <Policy>Spike-Arrest</Policy>
    </Policies>
    <Resources>
        <Resource>jsc://extract-token.js</Resource>
    </Resources>
    <SharedFlows>
        <SharedFlow>default</SharedFlow>
    </SharedFlows>
</SharedFlowBundle>

Atributos de configuración base

Nombre Descripción Predeterminado ¿Es obligatorio?
SharedFlowBundle
name Nombre del paquete de flujo compartido, que debe ser único en una organización. Los caracteres válidos son: A-Za-z0-9_- N/A Sí
revision Número de revisión de la configuración del paquete de flujo compartido. No es necesario que defina explícitamente el número de revisión, ya que Apigee hace un seguimiento automático de la revisión actual del flujo compartido. N/A No

Elementos de configuración base

Nombre Descripción Predeterminado ¿Es obligatorio?
SharedFlowBundle
ConfigurationVersion Versión del esquema de configuración del paquete de flujo compartido al que se ajusta este flujo compartido. Por el momento, los únicos valores admitidos son majorVersion 4 y minorVersion 0. Este ajuste se puede usar en el futuro para habilitar la evolución del formato del paquete de flujo compartido. 4.0 No
CreatedAt y CreatedBy Fecha y hora (en tiempo de época) en las que se creó el paquete de flujo compartido y el correo del usuario que lo creó.
Description Descripción textual del flujo compartido. Si se proporciona, la descripción se mostrará en la interfaz de usuario de Apigee. N/A No
DisplayName Nombre descriptivo que puede ser diferente del atributo name de la configuración del flujo compartido. N/A No
LastModifiedAt y LastModifiedBy Fecha y hora (en tiempo de época) en las que se modificó por última vez el paquete de flujo compartido, junto con el correo del usuario que lo modificó.
Policies Lista de políticas del directorio /policies de este flujo compartido. Normalmente, solo verás este elemento cuando el flujo compartido se haya creado con la interfaz de gestión de Edge. Se trata de un ajuste de "manifiesto" diseñado para proporcionar visibilidad sobre el contenido del flujo compartido. N/A No
Resources Lista de recursos (JavaScript, Python, Java y XSLT) del directorio /resources de este flujo compartido. Normalmente, solo verás este elemento cuando el flujo compartido se haya creado con la interfaz de usuario de Apigee. Se trata de un ajuste del manifiesto diseñado para proporcionar visibilidad sobre el contenido del flujo compartido. N/A No
SharedFlows Flujo compartido que contiene este paquete. N/A Sí

Políticas

/sharedflowbundle/policies

Al igual que en un proxy de API, en un paquete de flujo compartido, el directorio /policies contiene el XML de configuración de todas las políticas que se pueden adjuntar al flujo compartido del paquete. Las políticas comparten un subconjunto de elementos, aunque este subconjunto se amplía con elementos específicos de la política. Para obtener más información sobre cómo configurar una política, consulta la referencia de políticas.

Recursos

/sharedflowbundle/resources

Los recursos son secuencias de comandos, código y transformaciones XSL que se pueden adjuntar a flujos de trabajo compartidos mediante políticas. Aparecen en la sección Secuencias de comandos del editor de flujo compartido en la interfaz de gestión.

Consulta los tipos de recursos admitidos en el artículo sobre gestión de recursos.

Flujos compartidos

/sharedflowbundle/sharedflows/default.xml

La configuración de SharedFlow define la secuencia en la que se deben ejecutar los elementos de flujo. Cada elemento secundario <Step> del elemento <SharedFlow> especifica una parte de la secuencia, como una llamada a una política.

La siguiente configuración de SharedFlow especifica tres políticas que se ejecutarán en una secuencia de arriba abajo (de izquierda a derecha en la consola de gestión), con la política SpikeArrest en primer lugar y la política FlowCallout en último lugar.

<SharedFlow name="default">
    <Step>
        <Name>Spike-Arrest</Name>
    </Step>
    <Step>
        <Name>Extract-Token</Name>
    </Step>
    <Step>
        <Name>Auth-Flow-Callout</Name>
    </Step>
</SharedFlow>

Atributos de configuración de flujos compartidos

Nombre Descripción Predeterminado ¿Es obligatorio?
SharedFlow
name El nombre del flujo compartido, que debe ser único en una organización. Los caracteres válidos son los siguientes: A-Za-z0-9_- N/A Sí
revision Número de revisión de la configuración del flujo compartido. No es necesario que defina explícitamente el número de revisión, ya que Apigee hace un seguimiento automático de la revisión actual del flujo compartido. N/A No

Elementos de configuración de flujos compartidos

Nombre Descripción Predeterminado ¿Es obligatorio?
SharedFlow Secuencia de políticas del flujo compartido. N/A Sí
Step Fase de la secuencia del flujo. N/A Sí
Name Nombre del elemento al que hace referencia el paso. El valor de este elemento debe ser el mismo que el identificador único del elemento, como el valor del atributo name de una política. N/A Sí