Documentazione di Oracle Cloud Infrastructure

Aggiornamento di un gateway API

Scopri come modificare i gateway API creati in precedenza con il servizio gateway API.

Dopo aver creato un gateway API, è possibile decidere di modificare il gateway API. Ad esempio, è possibile modificare il nome del gateway API o le tag ad esso applicate.

Tenere presente che esistono alcune proprietà dei gateway API per le quali non è possibile modificare i valori originali.

Puoi aggiornare i gateway API utilizzando la console, l'interfaccia CLI e l'interfaccia API.

    1. Nella pagina della lista Gateway, trovare il gateway API che si desidera aggiornare. Se hai bisogno di assistenza per trovare la pagina della lista o il gateway API, consulta Elenco dei gateway API.
    2. Dal menu Azioni Menu Azioni per il gateway API, effettuare le operazioni riportate di seguito.
      • Selezionare Modifica per modificare una delle seguenti proprietà del gateway API:
        • Modificare il nome del gateway API. Evitare di inserire 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 del certificato del gateway API e le risorse del certificato del 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.
      • Selezionare Sposta risorsa per spostare il gateway API in un altro compartimento.
      • Selezionare la scheda Tag per visualizzare e modificare le tag applicate al gateway API e selezionare Aggiungi tag per applicare più tag al gateway API.

  • Per aggiornare i gateway 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.
        • <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>

    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 l'operazione UpdateGateway per aggiornare un gateway API.