Solo DataPower Gateway (Classic)

Configurazione della politica Richiama per DataPower Gateway (v5 compatible)

Seguire questa procedura per configurare la politica Richiama per DataPower® Gateway (v5 compatible) nell'interfaccia utente dell'assembly.

Informazioni su questa attività

Nota: questo argomento descrive l'implementazione della politica Richiama in DataPower Gateway (v5 compatible). Se stai utilizzando DataPower API Gateway, vedi Configurazione della politica di richiamo per DataPower API Gateway. Per informazioni sui diversi tipi di gateway, consultare Tipi di gatewayAPI Connect.

Per i dettagli su come configurare la politica nella fonte OpenAPI , vedi invoke.

Potresti notare che l'ultima invoke nella loro politica è sostituita da una proxy. La sostituzione a volte viene eseguita automaticamente da IBM® API Connect DataPower Gateway per migliorare le prestazioni. proxy è funzionalmente equivalente a invoke, ma il chiamante dell'API potrebbe notare le seguenti differenze quando viene utilizzato proxy .
  • Se la richiesta di HTTP fatta da invoke o proxy riceve un reindirizzamento (3xx) risposta:
    • invoke restituisce la risposta che segue la risposta di reindirizzamento.
    • proxy non segue3xxe viene restituita la risposta di reindirizzamento.
  • Lo strumento di test IBM API Connect mostra che proxy è stato utilizzato, ma invoke viene visualizzato nei record di latenza dell'analisi.
  • La risposta da proxy può contenere spazi o caratteri di escape diversi da una risposta da invoke. Nonostante le differenze nella risposta, è ancora valida.
Se si desidera impedire la sostituzione dell'ultima invoke nell'assembly con proxy, è possibile impostare la proprietà API api.properties.x-ibm-gateway-optimize-invoke su false. Per ulteriori informazioni, consultare Proprietà API.

Procedura

  1. Nel riquadro di navigazione, fai clic su Icona di sviluppo nel quadro di navigazione Develop, quindi seleziona la scheda API.
    Viene aperta la pagina Sviluppa .
  2. Fai clic sul titolo della definizione API che vuoi utilizzare.
  3. Selezionare la scheda Gateway , quindi fare clic su Politiche nel riquadro di navigazione.
    Per ulteriori informazioni sull'utilizzo dell'editor di assemblaggio per un'API, consultare L'editor di assemblaggio.
  4. Trova la politica Richiama nella tavolozza e trascina la politica nell'area.
  5. Specificare le seguenti proprietà.
    Tabella 1. Proprietà della politica Richiama
    Etichetta proprietà Obbligatorio Descrizione Tipo di dati
    Titolo Vero Il titolo della politica.

    Il valore predefinito è invoke.

    stringa
    Descrizione N Una descrizione della politica. stringa
    URL Vero Specifica un indirizzo URL per il servizio di destinazione.

    Per un'API SOAP, viene aggiunto di default un URL. Ove possibile, il valore di Invoke URL viene fornito dalle informazioni definite nel WSDL importato.

    stringa
    Profilo TLS N Specifica un profilo TLS da utilizzare per la trasmissione sicura dei dati. stringa
    Scadenza Vero Il tempo di attesa prima di una risposta dall'endpoint (in secondi).

    Il valore predefinito è 60.

    intero
    Segui reindirizzamenti N Specifica il comportamento se il server back-end restituisce il codice di stato HTTP 301 Moved Permanently . Se si seleziona questa casella di controllo, il criterio invoke segue il reindirizzamento URL effettuando un'ulteriore chiamata all'indirizzo URL specificato nell'intestazione Location della risposta. Se si deseleziona questa casella di spunta, invoke salva il codice di stato 301 e la chiamata API viene considerata completa.
    Nota: la proprietà follow-redirect è supportata solo da DataPower API Gateway. Se si utilizza DataPower Gateway (v5 compatible), invoke segue sempre il reindirizzamento URL ; il criterio (non supportato da ) salva il codice di stato e completa la chiamata API senza seguire il reindirizzamento proxy (non supportata da DataPower API Gateway ) salva il codice di stato 301 e completa la chiamata API senza seguire il reindirizzamento URL.
    booleano
    Nome utente N Il nome utente da utilizzare per l'autenticazione di base HTTP. stringa
    Password N La password da utilizzare per l'autenticazione di base HTTP. stringa
    Metodo HTTP Vero Il metodo HTTP da utilizzare per Richiama. Di seguito i valori validi.
    • Conserva
    • RICHIAMA
    • INVIARE
    • INSERISCI
    • ELIMINA
    • PATCH
    • INTESTAZIONE
    • OPZIONI
    Il valore predefinito è GET. Tuttavia, se impostato su Keep o se la proprietà viene rimossa dalla sorgente, viene utilizzato il metodo HTTP della richiesta in arrivo.
    stringa
    Compressione N Selezionare questa casella di spunta per abilitare la compressione Content - Encoding al caricamento.

    La casella di spunta è deselezionata per impostazione predefinita.

    booleano

    Tipo di cache

    N Il tipo di cache determina se mettere in cache i documenti, rispettando o sovrascrivendo le direttive di HTTP Cache Control ricevute nella risposta dal sito di destinazione URL. Questa proprietà ha effetto solo quando viene ricevuta una risposta, altrimenti la politica restituisce sempre la risposta non scaduta precedentemente salvata nella cache.
    I valori validi sono:
    Protocollo
    Il comportamento della cache è determinato dalle intestazioni Cache - Control sulla risposta, in conformità con RFC 7234.

    Per ottimizzare le prestazioni, se il gateway riceve più di una richiesta per una risorsa che non è presente nella cache ma che potrebbe essere memorizzata nella cache quando viene ricevuta la risposta dal sito URL di destinazione, il gateway invia solo una richiesta al sito URL di destinazione; le altre richieste non vengono elaborate fino a quando non viene ricevuta la risposta alla prima richiesta e non viene determinato il comportamento della cache in base a tale risposta. Se la risposta indica che la memorizzazione nella cache è possibile, il gateway risponde a tutte le richieste in attesa con la risorsa memorizzata nella cache. Se la risposta indica che il caching non è possibile, il gateway invia tutte le richieste in attesa al sito di destinazione URL.

    Utilizzare questa opzione solo se si prevede che le risposte dal sito URL di destinazione possano essere memorizzate nella cache, nel qual caso dovrebbe migliorare le prestazioni e limitare la richiesta al sito URL di destinazione. Se, tuttavia, la destinazione URL non indica mai che il gateway deve memorizzare nella cache la sua risposta, le prestazioni potrebbero essere ridotte rispetto all'opzione No Cache.

    Nessuna cache
    Le risposte del sito URL di destinazione non vengono memorizzate nella cache del gateway, indipendentemente dalle intestazioni di cache restituite. In questo caso, ogni richiesta del client viene inviata alla destinazione URL.

    Usare questa opzione se non si vuole memorizzare nella cache nessuna delle risposte del backend sul gateway, o se è improbabile che una risposta dal sito di destinazione URL permetta la memorizzazione nella cache attraverso le impostazioni dell'intestazione Cache-Control.

    TTL (Time to Live)
    Questa opzione è simile all'opzione Protocollo tranne per il fatto che consente di specificare la quantità di tempo in cui si desidera che la risposta corretta dal richiamo o dal proxy rimanga nella cache. Utilizzare questa opzione solo se si prevede che le risposte del sito URL di destinazione possano essere memorizzate nella cache.

    Il valore predefinito è Protocollo.

    stringa
    TTL (Time to Live) N Specifica la quantità di tempo, in secondi, in cui la risposta rimane nella cache. Si applica solo se la proprietà Tipo di cache è impostata su Time to Live. Immettere un valore compreso nell'intervallo da 5 a 31708800.

    Il valore predefinito è 900.

    intero
    Chiave della cache N Specifica l'identificativo univoco della voce cache del documento. Se questo valore non viene specificato, l'intera stringa URL verrà utilizzata come chiave. stringa
    Arresta in caso di errore N Selezionare gli errori che, se generati durante l'esecuzione della politica, causano l'arresto del flusso di assemblaggio. Se esiste un flusso catch configurato per l'errore, viene attivato per gestire l'errore generato. Se viene generato un errore e non vi sono errori selezionati per l'impostazione Arresta in caso di errore o se l'errore generato non è uno degli errori selezionati, l'esecuzione della politica è consentita e il flusso di assemblaggio continua. stringa

    Variabile oggetto risposta

    N Il nome di una variabile che verrà utilizzata per archiviare i dati della risposta. Per impostazione predefinita, la risposta di chiamata, ovvero il corpo, le intestazioni, statusCode E statusMessage, viene salvato nella variabile Messaggio. Utilizzare questa proprietà per specificare un'ubicazione alternativa in cui memorizzare la risposta di richiamo. È possibile fare riferimento a questa variabile in altre azioni, come ad esempio Mappa.
    Nota: se si desidera che la risposta venga salvata in messaggio, lasciare vuota la proprietà Variabile oggetto risposta , non fornire il valore message.
    stringa
    Buffering N Selezionare Buffering per specificare se bufferizzare il payload. Se si seleziona Buffering, il payload viene bufferizzato e il criterio Invoke può controllare il tipo di payload. Se non si seleziona Buffering, il payload viene trasmesso in streaming e il criterio Invoke non può controllare il tipo di payload.
    Nota: Se si attiva il buffering, è necessario configurare anche un criterio di analisi per interpretare il payload. Senza una politica Parse, il payload rimane un buffer non interpretato e la politica Invoke ha successo se il servizio di backend accetta payload di tipo binary o detect. Se è configurato un criterio Parse, esso disabilita implicitamente lo streaming, anche se il buffering è disattivato, perché il parsing richiede il buffering dell'intero payload. Per ulteriori informazioni, vedere Parse.
    booleano
  6. Specificare una versione per il criterio facendo clic sull'icona Sorgente Icona origine OpenAPI e completando la sezione version del criterio YAML. Ad esempio:
    execute:
      - invoke:
          version: 1.0.0
          title: invoke
      ...
    È possibile specificare una versione per la politica compatibile con il gateway che si sta utilizzando. Quando l'API viene pubblicata, se la versione è incompatibile con il gateway, viene generato un errore di convalida che specifica le versioni disponibili.
  7. Fare clic su Salva.

Esempio

- invoke:
          version: 1.0.0
          title: get the account status
          timeout: 60
          verb: POST
          cache-response: time-to-live
          cache-ttl: 900
          stop-on-error:
            - ConnectionError
            - OperationError
          tls-profile: MyTLSProfile
          target-url: https://example.com/accounts/{id}?status={status}
          username: MyUser
          password: MyPassword