Riferimento per la configurazione del bundle di flussi condivisi

Questa pagina si applica a Apigee e Apigee ibrido.

Visualizza la documentazione di Apigee Edge.

Un flusso condiviso è una funzionalità riutilizzabile simile a un proxy API. Per maggiori informazioni, consulta la sezione Creazione di flussi condivisi riutilizzabili.

Struttura della directory del bundle del flusso condiviso

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 è il nome del 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 Predefinita Obbligatorio?
SharedFlowBundle
name Nome del bundle del flusso condiviso, che deve essere univoco all'interno di un'organizzazione. I caratteri validi includono: A-Za-z0-9_- N/A 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/A No

Elementi di configurazione di base

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

Criteri

/sharedflowbundle/policies

Come in un proxy API, in un bundle di flussi condivisi la directory /policies contiene l'XML di configurazione per tutti i criteri disponibili da collegare al flusso condiviso nel bundle. I criteri condividono un sottoinsieme di elementi, anche se questo sottoinsieme è aumentato con elementi specifici del criterio. Per saperne di più su come configurare un criterio, consulta la Panoramica di riferimento ai criteri.

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 nell'interfaccia utente di gestione.

Consulta Gestione delle 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, ad esempio 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), prima il criterio SpikeArrest e un criterio FlowCallout 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 Predefinita 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/A 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 flusso condiviso. N/A No

Elementi di configurazione del flusso condiviso

Nome Descrizione Predefinita Obbligatorio?
SharedFlow Sequenza di criteri nel flusso condiviso. N/A Sì
Step Fase nella sequenza del flusso. N/A Sì
Name Nome dell'elemento a cui si fa riferimento nel passaggio. Il valore di questo elemento deve corrispondere all'identificatore univoco dell'elemento, ad esempio il valore dell'attributo nome di un criterio. N/A Sì