Riferimento per la configurazione del bundle di flussi condivisi

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Un flusso condiviso è una funzionalità riutilizzabile simile a un proxy API. Per saperne di più, vedi Creazione di flussi condivisi riutilizzabili.

Struttura delle directory del bundle di flussi condivisi

La struttura delle directory del pacchetto di flussi condivisi, mostrata di seguito, è simile alla struttura delle directory di configurazione del proxy API.

Struttura delle directory del bundle di flussi condivisi

Una configurazione del bundle di flussi condivisi è costituita dai seguenti contenuti:

Configurazione di base Impostazioni di configurazione principali.
Norme File di configurazione in formato XML conformi agli schemi delle policy Apigee.
Risorse Script, file JAR e file XSLT a cui fanno riferimento le policy per eseguire una logica personalizzata.
Flussi condivisi Flussi condivisi inclusi in questo bundle.

Configurazione di base

Il file di configurazione di base si trova nella directory root del bundle. Il suo nome è il nome del bundle.

/sharedflowbundle/traffic-management-shared.xml

La configurazione di base definisce i contenuti del bundle di flussi condivisi, insieme alle informazioni per il monitoraggio della 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 pacchetto di flussi condivisi, 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 bundle di flussi condivisi. Non è necessario impostare esplicitamente il numero di revisione poiché Apigee tiene traccia automaticamente della 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 è conforme questo flusso condiviso. Al momento, gli unici valori supportati sono 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 (in formato epoch) in cui è stato creato il bundle di flussi condivisi e l'email dell'utente che lo ha creato.
Description Descrizione testuale del flusso condiviso. Se fornita, la descrizione verrà visualizzata nell'interfaccia utente di Apigee. N/D No
DisplayName Nome intuitivo che potrebbe essere diverso dall'attributo name della configurazione del flusso condiviso. N/D No
LastModifiedAt e LastModifiedBy Data/ora (in formato epoch) dell'ultima modifica del bundle di flussi condiviso, insieme all'indirizzo email dell'utente che l'ha modificato.
Policies Elenco dei criteri nella directory /policies di questo flusso condiviso. In genere vedrai questo elemento solo quando il flusso condiviso è stato creato utilizzando la UI di gestione di Edge. Si tratta semplicemente di un'impostazione "manifest", progettata per fornire visibilità sui contenuti del flusso condiviso. N/D No
Resources Elenco delle risorse (JavaScript, Python, Java, XSLT) nella directory /resources di questo flusso condiviso. In genere, questo elemento viene visualizzato solo quando il flusso condiviso è stato creato utilizzando la UI di Apigee. Si tratta semplicemente di un'impostazione del manifest, progettata per fornire visibilità sui contenuti del flusso condiviso. N/D No
SharedFlows Il flusso condiviso contenuto in questo bundle. N/D Sì

Norme

/sharedflowbundle/policies

Come in un proxy API, in un bundle di flussi condivisi la directory /policies contiene il codice XML di configurazione per tutti i criteri che possono essere collegati al flusso condiviso nel bundle. I criteri condividono un sottoinsieme di elementi, anche se questo sottoinsieme è integrato con elementi specifici per i criteri. Per saperne di più su come configurare una policy, Panoramica del riferimento ai criteri.

Risorse

/sharedflowbundle/resources

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

Consulta la sezione Gestione delle risorse per i tipi di risorse supportati.

Flussi condivisi

/sharedflowbundle/sharedflows/default.xml

La configurazione SharedFlow definisce la sequenza in cui devono essere eseguiti gli elementi del 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 policy da eseguire in una sequenza dall'alto verso il basso (da sinistra a destra nella console di gestione), con la policy SpikeArrest per prima e una policy FlowCallout per ultima.

<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 tiene traccia automaticamente della revisione corrente del 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 lo stesso dell'identificatore univoco dell'elemento, ad esempio il valore dell'attributo name di una norma. N/D Sì