Riferimento per la configurazione del bundle di flussi condivisi

Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione Documentazione di Apigee X.
Informazioni

Un flusso condiviso è una funzionalità riutilizzabile simile a un proxy API. Gran parte dei contenuti se hai già familiarità con i proxy API.

Se stai imparando a creare un flusso condiviso, inizia dall'argomento Flussi condivisi riutilizzabili.

Struttura del bundle di flusso condiviso

Un bundle di flusso condiviso è costituito dalla seguente configurazione:

Configurazione di base Impostazioni di configurazione principali. Vedi Configurazione di base.
Norme File di configurazione in formato XML conformi agli schemi dei criteri di Apigee Edge. Consulta Norme.
Risorse Script, file JAR e file KML a cui fanno riferimento i criteri per eseguire la logica personalizzata. Consulta Risorse:
SharedFlows Flussi condivisi inclusi in questo pacchetto. Vedi Flussi condivisi.

I componenti della tabella precedente sono definiti dai file di configurazione struttura della directory:

File di configurazione e struttura di directory di un bundle di flusso condiviso

Questa sezione descrive i file di configurazione e la struttura delle directory di un flusso condiviso gruppo.

Configurazione di base

Il file di configurazione di base si trova nella directory radice del bundle. Si chiama per il bundle.

/sharedflowbundle/traffic-management-shared.xml

La configurazione di base definisce i contenuti del bundle di flusso condiviso, insieme alle informazioni per monitorare la cronologia delle revisioni del bundle.

<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>

Attributi di configurazione di base

Nome Descrizione Predefinito Obbligatorio?
SharedFlowBundle
name Il nome del bundle del flusso condiviso, che deve essere univoco all'interno di un'organizzazione. La i caratteri che puoi utilizzare nel nome sono limitati ai seguenti: A-Za-z0-9_- N/D
revision Il numero di revisione della configurazione del bundle di flussi condiviso. Non è necessario impostare in modo esplicito il numero di revisione, poiché Apigee Edge monitora automaticamente una revisione del flusso condiviso. N/D No

Elementi di configurazione di base

Nome Descrizione Predefinito Obbligatorio?
SharedFlowBundle
ConfigurationVersion La versione dello schema di configurazione del bundle di flussi condivisi a cui questo flusso condiviso conforme. Al momento l'unico valore supportato è mainVersion 4 e minorVersion 0. Questo l'impostazione potrà essere utilizzata in futuro per consentire l'evoluzione del bundle dei flussi condivisi formato. 4.0 No
CreatedAt e CreatedBy La data e l'ora (espressa nell'epoca) in cui è stato creato il bundle di flusso condiviso, insieme all'elemento Indirizzo email dell'utente che l'ha creato.
Description Una descrizione testuale del flusso condiviso. Se fornita, la descrizione verrà visualizzata in la UI di gestione perimetrale. N/D No
DisplayName Un nome semplice che potrebbe essere diverso dall'attributo name dell' configurazione di flusso condivisa. N/D No
LastModifiedAt e LastModifiedBy La data/l'ora (nel fuso orario) dell'ultima modifica del bundle di flusso condiviso, insieme a l'indirizzo email dell'utente che l'ha modificato.
Policies Un elenco di criteri nella directory /policies di questo flusso condiviso. Tu di solito vedrà questo elemento solo quando il flusso condiviso è stato creato utilizzando l'interfaccia un'interfaccia utente di gestione. Si tratta semplicemente di un "manifest" progettata per dare visibilità i contenuti del flusso condiviso. N/D No
Resources Un elenco di risorse (JavaScript, Python, Java, Hadoop) nel /resources directory di questo flusso condiviso. Normalmente vedrai questo elemento solo quando il flusso condiviso è stato creato utilizzando la UI di gestione perimetrale. Si tratta semplicemente di un "manifest" progettata per forniscono visibilità sui contenuti del flusso condiviso. N/D No
SharedFlows Specifica il flusso condiviso contenuto in questo bundle.

Tieni presente che al momento questo elemento supporta un solo elemento secondario <SharedFlow>. Solo uno flusso condiviso può essere aggiunto a un bundle di flussi condivisi.

N/D

Flussi condivisi

/sharedflowbundle/sharedflows/default.xml

La configurazione di SharedFlow definisce la sequenza in cui devono essere eseguiti gli elementi di flusso. <SharedFlow> <Step> dell'elemento ciascuno degli elementi figlio specifica una parte della sequenza, come una chiamata a un criterio.

La seguente configurazione di SharedFlow specifica tre criteri da eseguire in un sequenza dall'alto verso il basso (da sinistra a destra nella console di gestione), con prima il criterio di arresto anomalo e un Norme sui callout di flusso per ultimo.

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

Attributi di configurazione del flusso condiviso

Nome Descrizione Predefinito Obbligatorio?
SharedFlow
name Il nome del flusso condiviso, che deve essere univoco all'interno di un'organizzazione. La i caratteri che puoi utilizzare nel nome sono limitati ai seguenti: A-Za-z0-9_- N/D
revision Il numero di revisione della configurazione del flusso condiviso. Non è necessario impostare esplicitamente il numero di revisione, poiché Apigee Edge traccia automaticamente la revisione corrente un flusso condiviso. N/D No

Elementi di configurazione del flusso condiviso

Nome Descrizione Predefinito Obbligatorio?
SharedFlow Definisce la sequenza di criteri nel flusso condiviso. N/D
Step Definisce un passaggio, una fase nella sequenza del flusso. N/D
Name Specifica il nome dell'elemento a cui fa riferimento il passaggio. Il valore di questo elemento deve essere Uguale all'identificatore univoco dell'articolo, ad esempio il valore dell'attributo del nome di un criterio. N/D

Norme

/sharedflowbundle/policies

Come in un proxy API, in un bundle di flusso condiviso la directory /policies contiene XML di configurazione per tutti i criteri disponibili da collegare al flusso condiviso nel bundle. Le norme condividono un sottoinsieme di elementi, che è però ampliato con elementi che sono specifiche delle norme. Per saperne di più su come configurare un criterio, consulta l'argomento relativo al criterio desiderato. Puoi contattarli anche da Riferimento alle norme Panoramica.

Risorse

/sharedflowbundle/resources

Le risorse sono script, codice e trasformazioni XSL che possono essere collegati a flussi condivisi utilizzando i criteri. Vengono visualizzate nella sezione Script dell'editor del flusso condiviso nella nell'interfaccia utente.

Consulta File di risorse per le tipi di risorse.

Pubblica domande nel Forum per gli sviluppatori Apigee.