Documentazione dell'infrastruttura Oracle Cloud

Aggiornamento di una distribuzione API

Scopri come modificare le distribuzioni API create in precedenza con il servizio gateway API.

Dopo aver distribuito un'interfaccia API su un gateway API mediante la creazione di una distribuzione API, è possibile decidere di modificare la distribuzione dell'interfaccia API. Ad esempio, potresti voler modificare una specifica di distribuzione API per aggiungere altri backend alla distribuzione API.

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

È possibile aggiornare le distribuzioni API utilizzando la console, l'interfaccia CLI e l'interfaccia API. È possibile aggiornare una specifica di distribuzione API utilizzando la console o modificando un file JSON.

    1. Nella pagina della lista Gateway selezionare il gateway API contenente la distribuzione 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. In Risorse, selezionare Distribuzioni.

      Viene visualizzata la pagina dell'elenco Distribuzioni. Tutte le distribuzioni API nel gateway API selezionato vengono visualizzate in una tabella.

    3. Dal menu Azioni (tre punti) per la distribuzione API che si desidera aggiornare, effettuare le operazioni 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 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 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.
        • <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:

        • 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 l'operazione UpdateDeployment per aggiornare una distribuzione API.