Riferimento per la configurazione del bundle di flussi condivisi

Questa pagina si applica a Apigee e Apigee ibridi.

Visualizza documentazione di Apigee Edge.

Un flusso condiviso è una funzionalità riutilizzabile simile a un proxy API. Per ulteriori informazioni, consulta Creare flussi condivisi riutilizzabili.

Struttura della directory del bundle di flussi condivisi

La struttura della directory del bundle di flusso condiviso, mostrata di seguito, è simile alla Struttura della directory di configurazione del proxy API.

Struttura della directory del bundle del flusso condiviso

Una configurazione del bundle di flusso condiviso è costituita dai seguenti contenuti:

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

Configurazione di base

Il file di configurazione di base si trova nella directory radice del bundle. Il nome è uguale al nome del pacchetto.

/sharedflowbundle/traffic-management-shared.xml

La configurazione di base definisce i contenuti del bundle di flussi condivisi, 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 Nome del bundle del flusso condiviso, che deve essere univoco all'interno di un'organizzazione. Valido tra cui: A-Za-z0-9_- N/D Sì
revision Numero di revisione della configurazione del bundle di flussi condiviso. Non è necessario impostare esplicitamente il numero di revisione poiché Apigee monitora automaticamente la revisione corrente del flusso condiviso. N/D No

Elementi di configurazione di base

Nome Descrizione Predefinito Obbligatorio?
SharedFlowBundle
ConfigurationVersion Versione dello schema di configurazione del bundle di flussi condivisi a cui questo flusso condiviso conforme. Al momento, l'unico valore supportato è majorVersion 4 e minorVersion 0. Questa impostazione potrebbe essere utilizzata in futuro per consentire l'evoluzione del formato del bundle di flussi condivisi. 4.0 No
CreatedAt e CreatedBy Data/ora (nel tempo dell'epoca) in cui è stato creato il bundle di flusso condiviso e nell'email dell'utente che l'ha creato.
Description Descrizione testuale del flusso condiviso. Se fornita, la descrizione verrà visualizzata nell'interfaccia utente di Apigee. N/D No
DisplayName Nome semplice che potrebbe essere diverso dall'attributo name dell' configurazione di flusso condivisa. N/D No
LastModifiedAt e LastModifiedBy Data/ora (in epoch time) dell'ultima modifica del bundle di flussi condiviso, insieme all'email dell'utente che lo ha modificato.
Policies 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'impostazione "manifest", progettata per fornire visibilità ai contenuti del flusso condiviso. N/D No
Resources Elenco delle risorse (JavaScript, Python, Java, XSLT) nella directory /resources di questo flusso condiviso. Normalmente vedrai questo elemento solo quando il flusso condiviso è stato creato utilizzando la UI di Apigee. Si tratta semplicemente di un'impostazione del file manifest, progettata per forniscono visibilità sui contenuti del flusso condiviso. N/D No
SharedFlows Il flusso condiviso contenuto in questo bundle. N/D Sì

Criteri

/sharedflowbundle/policies

Come in un proxy API, in un bundle di flussi condivisi la directory /policies contiene il file XML di configurazione di tutti i criteri disponibili da associare 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, Panoramica della sezione Riferimento alle norme.

Risorse

/sharedflowbundle/resources

Le risorse sono script, codice e trasformazioni XSL che possono essere collegate ai flussi condivisi utilizzando i criteri. Questi vengono visualizzati nella sezione Script dell'editor di flusso condiviso nell'interfaccia utente di gestione.

Consulta Gestire le risorse per i tipi di risorse supportati.

Flussi condivisi

/sharedflowbundle/sharedflows/default.xml

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

La seguente configurazione di SharedFlow specifica tre criteri da eseguire in una sequenza dall'alto verso il basso (da sinistra a destra nella console di gestione), con il criterio SpikeArrest in primo luogo e un criterio FlowCallout in 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. I caratteri validi includono: A-Za-z0-9_- N/D Sì
revision Numero di revisione della configurazione del flusso condiviso. Non è necessario impostare esplicitamente il numero di revisione poiché Apigee monitora automaticamente la revisione corrente del relativo flusso condiviso. N/D No

Elementi di configurazione del flusso condiviso

Nome Descrizione Predefinito Obbligatorio?
SharedFlow Sequenza di criteri nel flusso condiviso. N/D Sì
Step Fase nella sequenza del flusso. N/D Sì
Name 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 Sì