Aggiornamento di un gateway API o di una distribuzione API

• Console
• CLI
• API

• 1. Aprire il menu di navigazione e fare clic su Servizi per sviluppatori. In Gestione API, fare clic su Gateway.
  2. Selezionare il compartimento contenente il gateway API o la distribuzione API che si desidera aggiornare.
  3. Fare clic sul nome del gateway API per aprire la pagina dei dettagli del gateway API.

  4. Per aggiornare un gateway API, eseguire una delle azioni riportate di seguito.

     • Fare clic su Modifica per modificare una delle seguenti proprietà del gateway API:
       • Modificare il nome del gateway API. Evitare di fornire informazioni riservate.
       • Abilitare o disabilitare l'uso dei gruppi di sicurezza di rete (NSG) per controllare l'accesso al e dal gateway API utilizzando le regole di sicurezza definite per i gruppi di sicurezza di rete specificati (fino a un massimo di cinque gruppi di sicurezza di rete). È possibile utilizzare le regole di sicurezza definite per i gruppi NSG anziché, o in aggiunta, quelle definite per le liste di sicurezza. I gruppi NSG possono appartenere allo stesso compartimento del gateway API, ma non è necessario. Vedere Gruppi di sicurezza di rete.
       • Modificare il certificato TLS e il nome di dominio utilizzati dal gateway API. Tenere presente che le risorse dei certificati API Gateway e le risorse dei certificati di servizio Certificati vengono visualizzate solo se sono disponibili nel compartimento selezionato. Vedere Impostazione di domini personalizzati e certificati TLS.
       • Modificare le impostazioni di configurazione della cache delle risposte. Vedere Inserimento nella cache delle risposte per migliorare le prestazioni.
       • Modificare i bundle CA e autorità di certificazione inclusi nel truststore del gateway API come CA personalizzate e bundle CA personalizzati (oltre al bundle CA predefinito). Vedere Personalizzazione dei truststore per la verifica dei certificati TLS.
     • Fare clic su Sposta risorsa per spostare il gateway API in un altro compartimento.
     • Fare clic sulla scheda Tag per visualizzare e modificare le tag applicate al gateway API e fare clic su Aggiungi tag per applicare più tag al gateway API.

  5. Per aggiornare una distribuzione API, eseguire le azioni riportate di seguito.

     1. Nella pagina Dettagli gateway selezionare Distribuzioni dalla lista Risorse.
     2. Fare clic su il menu Azioni () per la distribuzione API che si desidera aggiornare ed eseguire una delle azioni riportate di seguito.

        • Selezionare Modifica per modificare il nome della distribuzione API o per sostituire la specifica di distribuzione API originale. È possibile modificare la specifica di distribuzione API originale selezionando una delle seguenti opzioni:

          • Da zero: modificare le proprietà della specifica di distribuzione API fornendo i valori nella console.
          • Carica un'interfaccia API esistente: modificare le proprietà della specifica di distribuzione API caricando un file JSON di sostituzione.

          Per ulteriori informazioni sulla definizione delle specifiche di distribuzione API, vedere Creazione di una specifica di distribuzione API. Evitare di fornire informazioni riservate.

        • Selezionare Sposta risorsa per spostare la distribuzione API in un altro compartimento.
        • Selezionare Aggiungi tag e Visualizza tag per modificare e visualizzare le tag applicate alla distribuzione API.

• Per aggiornare i gateway API e le distribuzioni API esistenti utilizzando l'interfaccia CLI:

  1. Configurare l'ambiente client per l'uso dell'interfaccia CLI (Configuring Your Client Environment to use the CLI for API Gateway Development).

  2. Per aggiornare un gateway API esistente:

     1. Aprire un prompt dei comandi ed eseguire oci api-gateway gateway update per aggiornare il gateway API:

        oci api-gateway gateway update --gateway-id <gateway-ocid> --<property-to-update> <property-value>

        dove:

        • <gateway-ocid> è l'OCID del gateway API da aggiornare. Per informazioni sull'OCID del gateway API, vedere Elenco dei gateway API e delle distribuzioni API.
        • <property-to-update> è la proprietà da aggiornare. Si noti che è possibile modificare solo i valori per display-name, --response-cache-details, --network-security-group-ids, --ca-bundles, freeform-tags e defined-tags (e certificate-id> se originariamente impostato per il gateway API). Tutti gli altri valori devono essere identici ai valori nella definizione del gateway originale.
        • <property-value> è il nuovo valore della proprietà che si desidera modificare.

        Ad esempio:

        oci api-gateway gateway update --gateway-id ocid1.apigateway.oc1..aaaaaaaab______hga --display-name "Hello World Gateway - version 2"

        La risposta al comando include quanto riportato di seguito.

        • Stato del ciclo di vita (ad esempio, ACTIVE, FAILED).
        • ID della richiesta di lavoro per aggiornare il gateway API (i dettagli delle richieste di lavoro sono disponibili per sette giorni dopo il completamento, l'annullamento o l'errore).

        Se si desidera che il comando attenda la restituzione del controllo fino a quando il gateway API non è attivo (o la richiesta non è riuscita), includere uno o entrambi i parametri riportati di seguito.

        • --wait-for-state ACTIVE
        • --wait-for-state FAILED

        Ad esempio:

        oci api-gateway gateway update --gateway-id ocid1.apigateway.oc1..aaaaaaaab______hga --display-name "Hello World Gateway - version 2" --wait-for-state ACTIVE

     2. (Facoltativo) Per visualizzare lo stato della richiesta di lavoro che sta aggiornando il gateway API, immettere:

        oci api-gateway work-request get --work-request-id <work-request-ocid>

     3. (Facoltativo) Per visualizzare i log della richiesta di lavoro che sta aggiornando il gateway API, immettere:

        oci api-gateway work-request-log list --work-request-id <work-request-ocid>

     4. (Facoltativo) Se la richiesta di lavoro che sta aggiornando il gateway API non riesce e si desidera esaminare i log degli errori, immettere:

        oci api-gateway work-request-error --work-request-id <work-request-ocid>

     5. (Facoltativo) Per verificare che il gateway API sia stato aggiornato, immettere il comando seguente e verificare che le proprietà del gateway API siano quelle previste:

        oci api-gateway gateway get --gateway-id <gateway-ocid>

  3. Per aggiornare una distribuzione API esistente:

     1. Aprire un prompt dei comandi ed eseguire oci api-gateway deployment update per aggiornare la distribuzione API:

        oci api-gateway deployment update --deployment-id <deployment-ocid> --specification file:///<filename>

        dove:

        • <deployment-ocid> è l'OCID della distribuzione API da aggiornare. Per informazioni sull'OCID della distribuzione API, vedere Elenco dei gateway API e delle distribuzioni API.
        • <filename> è la posizione relativa e il nome file del file JSON contenente la specifica di distribuzione API di sostituzione. Ad esempio, replacement-specification.json. Per ulteriori informazioni sulla definizione delle specifiche di distribuzione API, vedere Creazione di una specifica di distribuzione API.

        Ad esempio:

        oci api-gateway deployment update --deployment-id ocid1.apideployment.oc1..aaaaaaaaab______pwa --specification file:///Users/jdoe/work/replacement-specification.json

        La risposta al comando include quanto riportato di seguito.

        • Stato del ciclo di vita (ad esempio, ACTIVE, FAILED).
        • ID della richiesta di lavoro per aggiornare la distribuzione dell'API (i dettagli delle richieste di lavoro sono disponibili per sette giorni dopo il completamento, l'annullamento o l'errore).

        Se si desidera che il comando attenda la restituzione del controllo fino a quando la distribuzione dell'API non è attiva (o la richiesta non è riuscita), includere uno o entrambi i parametri riportati di seguito.

        • --wait-for-state ACTIVE
        • --wait-for-state FAILED

        Ad esempio:

        oci api-gateway deployment update --deployment-id ocid1.apideployment.oc1..aaaaaaaaab______pwa --specification file:///Users/jdoe/work/replacement-specification.json --wait-for-state ACTIVE

     2. (Facoltativo) Per visualizzare lo stato della richiesta di lavoro che sta aggiornando la distribuzione dell'API, immettere:

        oci api-gateway work-request get --work-request-id <work-request-ocid>

     3. (Facoltativo) Per visualizzare i log della richiesta di lavoro che sta aggiornando la distribuzione dell'API, immettere:

        oci api-gateway work-request-log list --work-request-id <work-request-ocid>

     4. (Facoltativo) Se la richiesta di lavoro che sta aggiornando la distribuzione dell'API non riesce e si desidera esaminare i log degli errori, immettere:

        oci api-gateway work-request-error --work-request-id <work-request-ocid>

     5. (Facoltativo) Per verificare che la distribuzione dell'API sia stata aggiornata, immettere il comando seguente e verificare che le proprietà della distribuzione dell'API siano quelle previste:

        oci api-gateway deployment get --deployment-id <deployment-ocid>

  Per ulteriori informazioni sull'uso dell'interfaccia CLI, vedere Command Line Interface (CLI, interfaccia a riga di comando). Per un elenco completo dei flag e delle opzioni disponibili per i comandi della CLI, vedere la Guida della CLI.

• Eseguire le operazioni riportate di seguito.

  • Operazione UpdateGateway per aggiornare un gateway API.
  • Operazione UpdateDeployment per aggiornare una distribuzione API.