Distribuzione di un'API in un gateway API mediante la creazione di una distribuzione API

Per utilizzare la console per creare una distribuzione API, immettendo la specifica di distribuzione API nelle finestre di dialogo della console man mano che si va:

1. Nella pagina della lista Gateway selezionare il gateway API su cui si desidera distribuire l'API. Se hai bisogno di aiuto per trovare la pagina della lista o il gateway API, consulta la sezione relativa alla lista dei gateway API.

2. Nella scheda Distribuzioni selezionare Crea distribuzione e nella sezione Informazioni di base specificare quanto segue.

   • Nome: il nome della nuova distribuzione API. Evitare di fornire informazioni riservate.

   • Prefisso percorso: percorso in cui distribuire tutti gli instradamenti contenuti nella specifica di distribuzione API. Ad esempio:

     • /v1
     • /v2
     • /test/20191122

     Tenere presente che il prefisso del percorso di distribuzione specificato è il seguente:

     • deve essere preceduta da una barra (/) e può essere solo la singola barra
     • può contenere più barre in avanti (a condizione che non siano adiacenti), ma non deve terminare con una barra in avanti
     • può includere caratteri alfanumerici maiuscoli e minuscoli
     • può includere i caratteri speciali $ - _ . + ! * ' ( ) , % ; : @ & =
     • impossibile includere parametri e caratteri jolly

     Inoltre, se una distribuzione API ha una singola barra come prefisso del percorso di distribuzione, questa è l'unica distribuzione API consentita su un determinato gateway API. Non è possibile creare una distribuzione API con una singola barra come prefisso del percorso di distribuzione se esiste già un'altra distribuzione API nello stesso gateway API.

   • Compartimento: compartimento in cui creare la nuova distribuzione API.

3. (Facoltativo) Nella sezione Criteri di richiesta API, facoltativamente specificare i dettagli dei criteri di richiesta per fornire il supporto per:

   • Mutual-TLS: selezionare Abilita mTLS e immettere i dettagli per un criterio di richiesta mTLS (vedere Aggiunta del supporto mTLS alle distribuzioni API).
   • CORS: selezionare Aggiungi e immettere i dettagli per un criterio di richiesta CORS (vedere Aggiunta del supporto CORS alle distribuzioni API).
   • Limitazione dei tassi: selezionare Aggiungi e immettere i dettagli per un criterio di richiesta che limita la frequenza (vedere Limitazione del numero di richieste ai backend del gateway API).
   • Piani di utilizzo: selezionare Aggiungi e immettere i dettagli per un criterio di richiesta del piano di utilizzo (vedere Come rendere idonea una distribuzione API per l'inclusione in un piano di utilizzo).

4. (Facoltativo) Nella sezione Criteri di log API, facoltativamente specificare un livello di log di esecuzione per registrare informazioni sull'elaborazione all'interno del gateway API. Vedere Aggiunta di log alle distribuzioni API.

5. (Facoltativo) Nella sezione Tag, selezionare Aggiungi tag per applicare le tag alla risorsa. Se si dispone delle autorizzazioni per creare una risorsa, si dispone anche delle autorizzazioni per applicare tag in formato libero a tale risorsa. Per applicare una tag defined, è necessario disporre delle autorizzazioni per utilizzare la tag namespace. Per ulteriori informazioni sull'applicazione di tag, vedere Tag risorsa. Se non sei sicuro di applicare le tag, salta questa opzione o chiedi a un amministratore. È possibile applicare le tag in un secondo momento.

6. Selezionare Avanti per visualizzare la pagina Autenticazione e immettere i dettagli per un criterio di richiesta di autenticazione.
   • Nessuna autenticazione: selezionare questa opzione per concedere l'accesso non autenticato a tutti gli instradamenti nella distribuzione API.
   • Autenticazione singola: selezionare questa opzione per instradare tutte le richieste di autenticazione a un singolo server di autenticazione. Il server di autenticazione può essere un provider di identità che convalida i token Web JSON (JWT, JSON Web Token) o una funzione del responsabile autorizzazioni che convalida i token di accesso a più argomenti o a singolo argomento. Per ulteriori informazioni, fare riferimento agli argomenti sotto riportati.
     • Passaggio di token alle funzioni del responsabile autorizzazioni per aggiungere autenticazione e autorizzazione alle distribuzioni API
     • Convalida dei token per aggiungere autenticazione e autorizzazione alle distribuzioni API
   • Multi-Authentication: selezionare questa opzione per instradare le richieste di autenticazione a server di autenticazione diversi, in base alla variabile di contesto e alle regole immesse. Per ulteriori informazioni, vedere Aggiunta di più server di autenticazione alla stessa distribuzione API.

   Per ulteriori informazioni, vedere Aggiunta di autenticazione e autorizzazione alle distribuzioni API.

7. Selezionare Avanti per immettere i dettagli degli instradamenti nella distribuzione API.

8. Nella sezione Cicli, selezionare Aggiungi instradamento e specificare il primo instradamento nella distribuzione API che mappa un percorso e uno o più metodi a un servizio backend:

   • Percorso: un percorso per le chiamate API che utilizzano i metodi elencati per il servizio backend. Tenere presente che il percorso di instradamento specificato è il seguente:

     • è relativo al prefisso del percorso di distribuzione
     • deve essere preceduta da una barra ( / ) e può essere solo la singola barra
     • può contenere più barre in avanti (a condizione che non siano adiacenti) e può terminare con una barra in avanti
     • può includere caratteri alfanumerici maiuscoli e minuscoli
     • può includere i caratteri speciali $ - _ . + ! * ' ( ) , % ; : @ & =
     • può includere parametri e caratteri jolly (vedere Aggiunta di parametri di percorso e caratteri jolly ai percorsi di instradamento)
   • Metodi: uno o più metodi accettati dal servizio backend, separati da virgole. Ad esempio, GET, PUT.

   • Aggiungere un backend singolo o Aggiungere più backend: indica se instradare tutte le richieste allo stesso backend o instradare le richieste a backend diversi in base alla variabile di contesto e alle regole immesse.

     Queste istruzioni presuppongono di voler utilizzare un singolo backend, quindi selezionare Aggiungi un backend singolo. In alternativa, se si desidera utilizzare backend diversi, selezionare Aggiungi più backend e seguire le istruzioni in Utilizzo della console per aggiungere la selezione backend dinamica a una specifica di distribuzione API.

   • Tipo backend: il tipo di servizio backend, ovvero uno dei seguenti:
     • HTTP: per un backend HTTP, è inoltre necessario specificare un URL, i dettagli relativi al timeout e se disabilitare la verifica SSL (vedere Aggiunta di un URL HTTP o HTTPS come backend del gateway API).
     • Oracle Functions: per un backend OCI Functions, è inoltre necessario specificare l'applicazione e la funzione (vedere Aggiunta di una funzione nelle funzioni OCI come backend API Gateway).
     • Risposta stock: per un back-end di risposta stock, è inoltre necessario specificare il codice di stato HTTP, il contenuto nel corpo della risposta e uno o più campi di intestazione HTTP (vedere Aggiunta di risposte stock come back-end di API Gateway).
     • Logout: per un backend di logout, è inoltre necessario specificare una lista di URL consentiti a cui è possibile reindirizzare una richiesta per revocare i token e, facoltativamente, i dati da passare all'URL di logout (vedere Aggiunta del logout come backend di API Gateway).
   • Mostra criteri di richiesta di instradamento: richiedere i criteri da applicare all'instradamento (vedere Aggiunta di criteri di richiesta e di risposta alle specifiche di distribuzione API).
   • Mostra criteri di risposta di instradamento: criteri di risposta da applicare all'instradamento (vedere Aggiunta di criteri di richiesta e criteri di risposta alle specifiche di distribuzione API).
   • Mostra criteri di inserimento delle risposte nella cache: criteri di inserimento delle risposte nella cache da applicare all'instradamento (vedere Inserimento delle risposte nella cache per migliorare le prestazioni).
   • Mostra criteri di log degli instradamenti: criteri di log da applicare all'instradamento (vedere Aggiunta di log alle distribuzioni API).
9. Selezionare Crea per creare l'instradamento.
10. (Facoltativo) Selezionare Aggiungi instradamento per immettere i dettagli degli instradamenti aggiuntivi.
11. Selezionare Avanti per esaminare i dettagli immessi per la nuova distribuzione API.

12. Selezionare Crea per creare la nuova distribuzione API.

    Tenere presente che la creazione della nuova distribuzione API può richiedere alcuni minuti. Durante la creazione, la distribuzione API viene visualizzata con lo stato Creazione nella scheda Distribuzioni della pagina dei dettagli del gateway API. Una volta creata correttamente, la nuova distribuzione API viene visualizzata con lo stato Attivo.

    Inoltre, anziché creare immediatamente la nuova distribuzione API, è possibile crearla in un secondo momento utilizzando Resource Manager e Terraform, selezionando Salva come stack per salvare la definizione della risorsa come configurazione Terraform. Per ulteriori informazioni sul salvataggio degli stack dalle definizioni delle risorse, vedere Creazione di uno stack da una pagina di creazione delle risorse.

13. Se la distribuzione dell'API è stata visualizzata con stato Attivo per più di alcuni minuti (o se l'operazione di creazione della distribuzione dell'API non è riuscita):

    1. Selezionare il nome della distribuzione API nella scheda Distribuzioni della pagina dei dettagli del gateway API e selezionare Richieste di lavoro per visualizzare una panoramica dell'operazione di creazione della distribuzione API.
    2. Selezionare l'operazione Crea distribuzione per visualizzare ulteriori informazioni sull'operazione, inclusi i messaggi di errore, i messaggi di log e lo stato delle risorse associate.
    3. Se l'operazione di creazione della distribuzione API non è riuscita e non è possibile diagnosticare la causa del problema dalle informazioni sulla richiesta di lavoro, vedere Risoluzione dei problemi del gateway API.
14. (Facoltativo) Confermare che l'interfaccia API è stata distribuita correttamente chiamandola (vedere Chiamata di un'interfaccia API distribuita su un gateway API).

Per utilizzare la console per creare una distribuzione API, caricare la specifica di distribuzione API da un file JSON:

1. Nella pagina della lista Gateway selezionare il gateway API su cui si desidera distribuire l'API. Se hai bisogno di aiuto per trovare la pagina della lista o il gateway API, consulta la sezione relativa alla lista dei gateway API.

2. Nella scheda Distribuzioni selezionare Carica un'API di distribuzione esistente e nella sezione Informazioni di base specificare quanto segue.

   • Nome: il nome della nuova distribuzione API. Evitare di fornire informazioni riservate.

   • Prefisso percorso: percorso in cui distribuire tutti gli instradamenti contenuti nella specifica di distribuzione API. Ad esempio:

     • /v1
     • /v2
     • /test/20191122

     Tenere presente che il prefisso del percorso di distribuzione specificato è il seguente:

     • deve essere preceduta da una barra (/) e può essere solo la singola barra
     • può contenere più barre in avanti (a condizione che non siano adiacenti), ma non deve terminare con una barra in avanti
     • può includere caratteri alfanumerici maiuscoli e minuscoli
     • può includere i caratteri speciali $ - _ . + ! * ' ( ) , % ; : @ & =
     • impossibile includere parametri e caratteri jolly
   • Compartimento: compartimento in cui creare la nuova distribuzione API.
   • Specifica: il file JSON contenente la specifica di distribuzione API, trascinando e rilasciando il file o selezionando seleziona un file. Vedere Creazione di una specifica di distribuzione API.

   Inoltre, se una distribuzione API ha una singola barra come prefisso del percorso di distribuzione, questa è l'unica distribuzione API consentita su un determinato gateway API. Non è possibile creare una distribuzione API con una singola barra come prefisso del percorso di distribuzione se esiste già un'altra distribuzione API nello stesso gateway API.

3. (Facoltativo) Nella sezione Tag, selezionare Aggiungi tag per applicare le tag alla risorsa. Se si dispone delle autorizzazioni per creare una risorsa, si dispone anche delle autorizzazioni per applicare tag in formato libero a tale risorsa. Per applicare una tag defined, è necessario disporre delle autorizzazioni per utilizzare la tag namespace. Per ulteriori informazioni sull'applicazione di tag, vedere Tag risorsa. Se non sei sicuro di applicare le tag, salta questa opzione o chiedi a un amministratore. È possibile applicare le tag in un secondo momento.

4. Selezionare Avanti per esaminare i dettagli immessi per la nuova distribuzione API.

5. Selezionare Crea per creare la nuova distribuzione API.

   Tenere presente che la creazione della nuova distribuzione API può richiedere alcuni minuti. Durante la creazione, la distribuzione API viene visualizzata con lo stato Creazione nella scheda Distribuzioni della pagina dei dettagli del gateway API. Una volta creata correttamente, la nuova distribuzione API viene visualizzata con lo stato Attivo.

   Inoltre, anziché creare immediatamente la nuova distribuzione API, è possibile crearla in un secondo momento utilizzando Resource Manager e Terraform, selezionando Salva come stack per salvare la definizione della risorsa come configurazione Terraform. Per ulteriori informazioni sul salvataggio degli stack dalle definizioni delle risorse, vedere Creazione di uno stack da una pagina di creazione delle risorse.

6. Se la distribuzione dell'API è stata visualizzata con stato Attivo per più di alcuni minuti (o se l'operazione di creazione della distribuzione dell'API non è riuscita):

   1. Selezionare il nome della distribuzione API e selezionare Richieste di lavoro per visualizzare una panoramica dell'operazione di creazione della distribuzione API.
   2. Selezionare l'operazione Crea distribuzione per visualizzare ulteriori informazioni sull'operazione, inclusi i messaggi di errore, i messaggi di log e lo stato delle risorse associate.
   3. Se l'operazione di creazione della distribuzione API non è riuscita e non è possibile diagnosticare la causa del problema dalle informazioni sulla richiesta di lavoro, vedere Risoluzione dei problemi del gateway API.
7. (Facoltativo) Confermare che l'interfaccia API è stata distribuita correttamente chiamandola (vedere Chiamata di un'interfaccia API distribuita su un gateway API).

È possibile creare una distribuzione API da una risorsa API esistente utilizzando la descrizione API della risorsa API. In questo caso, la descrizione dell'API si basa su un file di descrizione dell'API caricato per la risorsa API (vedere Creazione di una risorsa API con una descrizione dell'API). Il file di descrizione dell'API fornisce alcuni valori iniziali per la specifica di distribuzione dell'API, che è possibile modificare ed estendere durante la creazione della distribuzione dell'API. In particolare, viene creato un instradamento predefinito per ogni percorso e metodo associato nella descrizione dell'API.

Per utilizzare la console per creare una distribuzione API da una risorsa API esistente, utilizzare una specifica di distribuzione API derivata da un file di descrizione API:

1. Nella pagina di elenco API selezionare il nome della risorsa API che si desidera distribuire. Per assistenza nella ricerca della pagina elenco, vedere Elenca risorse API.
2. (Facoltativo) Nella scheda Dettagli confermare che è stata creata una specifica di distribuzione API valida per la risorsa API da un file di descrizione API caricato. Se non è disponibile alcuna specifica di distribuzione API, vedere Creazione di una risorsa API con una descrizione API.
3. Selezionare Distribuisci per utilizzare le finestre di dialogo della console per creare una distribuzione API.

   Alcuni valori iniziali per le proprietà della specifica di distribuzione API mostrate nelle finestre di dialogo della console derivano dal file di descrizione dell'API.

4. Nella sezione Gateway selezionare il gateway API su cui creare la distribuzione dell'API.

5. Nella sezione Informazioni di base specificare quanto segue.

   • Nome: il nome della nuova distribuzione API. Evitare di fornire informazioni riservate.

   • Prefisso percorso: percorso in cui distribuire tutti gli instradamenti contenuti nella specifica di distribuzione API.

     Ad esempio:

     • /v1
     • /v2
     • /test/20191122

     Tenere presente che il prefisso del percorso di distribuzione specificato è il seguente:

     • deve essere preceduta da una barra (/) e può essere solo la singola barra
     • può contenere più barre in avanti (a condizione che non siano adiacenti), ma non deve terminare con una barra in avanti
     • può includere caratteri alfanumerici maiuscoli e minuscoli
     • può includere i caratteri speciali $ - _ . + ! * ' ( ) , % ; : @ & =
     • impossibile includere parametri e caratteri jolly

     Inoltre, se una distribuzione API ha una singola barra come prefisso del percorso di distribuzione, questa è l'unica distribuzione API consentita su un determinato gateway API. Non è possibile creare una distribuzione API con una singola barra come prefisso del percorso di distribuzione se esiste già un'altra distribuzione API nello stesso gateway API.

   • Compartimento: compartimento in cui creare la nuova distribuzione API.

6. (Facoltativo) Nella sezione Criteri di richiesta API, facoltativamente specificare i dettagli dei criteri di richiesta per fornire il supporto per:

   • Mutual-TLS: selezionare Abilita mTLS e immettere i dettagli per un criterio di richiesta mTLS (vedere Aggiunta del supporto mTLS alle distribuzioni API).
   • CORS: selezionare Aggiungi e immettere i dettagli per un criterio di richiesta CORS (vedere Aggiunta del supporto CORS alle distribuzioni API).
   • Limitazione dei tassi: selezionare Aggiungi e immettere i dettagli per un criterio di richiesta che limita la frequenza (vedere Limitazione del numero di richieste ai backend del gateway API).
   • Piani di utilizzo: selezionare Aggiungi e immettere i dettagli per un criterio di richiesta del piano di utilizzo (vedere Come rendere idonea una distribuzione API per l'inclusione in un piano di utilizzo).

7. (Facoltativo) Nella sezione Criteri di log API, facoltativamente specificare un livello di log di esecuzione per registrare informazioni sull'elaborazione all'interno del gateway API. Vedere Aggiunta di log alle distribuzioni API.

8. (Facoltativo) Nella sezione Tag, selezionare Aggiungi tag per applicare le tag alla risorsa. Se si dispone delle autorizzazioni per creare una risorsa, si dispone anche delle autorizzazioni per applicare tag in formato libero a tale risorsa. Per applicare una tag defined, è necessario disporre delle autorizzazioni per utilizzare la tag namespace. Per ulteriori informazioni sull'applicazione di tag, vedere Tag risorsa. Se non sei sicuro di applicare le tag, salta questa opzione o chiedi a un amministratore. È possibile applicare le tag in un secondo momento.

9. Selezionare Successivo per visualizzare la pagina Autenticazione e immettere i dettagli per un criterio di richiesta di autenticazione.
   • Nessuna autenticazione: selezionare questa opzione per concedere l'accesso non autenticato a tutti gli instradamenti nella distribuzione API.
   • Autenticazione singola: selezionare questa opzione per instradare tutte le richieste di autenticazione a un singolo server di autenticazione. Il server di autenticazione può essere un provider di identità che convalida i token Web JSON (JWT) o una funzione del responsabile autorizzazioni che convalida i token di accesso a più argomenti o a singolo argomento. Per ulteriori informazioni, fare riferimento agli argomenti sotto riportati.
     • Passaggio di token alle funzioni del responsabile autorizzazioni per aggiungere autenticazione e autorizzazione alle distribuzioni API
     • Convalida dei token per aggiungere autenticazione e autorizzazione alle distribuzioni API
   • Multi-Authentication: selezionare questa opzione per instradare le richieste di autenticazione a server di autenticazione diversi, in base alla variabile di contesto e alle regole immesse. Per ulteriori informazioni, vedere Aggiunta di più server di autenticazione alla stessa distribuzione API.
   Per ulteriori informazioni, vedere Aggiunta di autenticazione e autorizzazione alle distribuzioni API.

10. Selezionare Successivo per visualizzare la pagina Cicli ed esaminare e immettere i dettagli degli instradamenti nella distribuzione API.

    Per impostazione predefinita, viene creato un instradamento per ogni percorso e metodo associato presente nella descrizione dell'API. Inizialmente, ciascuno di questi instradamenti predefiniti viene creato con un back-end di risposta stock. Il codice di stato HTTP, il contenuto nel corpo del contenuto del corpo della risposta e l'intestazione vengono ottenuti dai dettagli nella descrizione dell'API. Se la descrizione dell'API non include informazioni di risposta per un determinato percorso e un metodo associato, viene creato un back-end predefinito di risposta stock per l'instradamento con 501 come codice di stato HTTP.

11. Esaminare a turno ogni instradamento predefinito, modificandone facoltativamente la configurazione se necessario per soddisfare le proprie esigenze, tra cui:

    • Indica se instradare tutte le richieste allo stesso backend o instradarle a backend diversi in base alla variabile di contesto e alle regole immesse (vedere Aggiunta dei backend del gateway API).
    • Aggiornamento dei criteri di richiesta, risposta, inserimento nella cache e registrazione (vedere Aggiunta di criteri di richiesta e di risposta alle specifiche di distribuzione delle API).
12. (Facoltativo) Selezionare Aggiungi instradamento per immettere i dettagli di altri instradamenti, oltre a quelli creati per impostazione predefinita dalla descrizione dell'API.
13. Selezionare Avanti per esaminare i dettagli immessi per la nuova distribuzione API.

14. Selezionare Crea per creare la nuova distribuzione API.

    Tenere presente che la creazione della nuova distribuzione API può richiedere alcuni minuti. Durante la creazione, la distribuzione API viene visualizzata con lo stato Creazione nella scheda Distribuzioni della pagina dei dettagli del gateway API. Una volta creata correttamente, la nuova distribuzione API viene visualizzata con lo stato Attivo.

15. Se la distribuzione dell'API è stata visualizzata con stato Attivo per più di alcuni minuti (o se l'operazione di creazione della distribuzione dell'API non è riuscita):

    1. Selezionare il nome della distribuzione API nella scheda Distribuzioni della pagina dei dettagli del gateway API e selezionare la scheda Richieste di lavoro per visualizzare una panoramica dell'operazione di creazione della distribuzione API.
    2. Selezionare l'operazione Crea distribuzione per visualizzare ulteriori informazioni sull'operazione, inclusi i messaggi di errore, i messaggi di log e lo stato delle risorse associate.
    3. Se l'operazione di creazione della distribuzione API non è riuscita e non è possibile diagnosticare la causa del problema dalle informazioni sulla richiesta di lavoro, vedere Risoluzione dei problemi del gateway API.
16. (Facoltativo) Confermare che l'interfaccia API è stata distribuita correttamente chiamandola (vedere Chiamata di un'interfaccia API distribuita su un gateway API).

Per creare una nuova distribuzione API utilizzando l'interfaccia CLI:

1. Configurare l'ambiente client per l'uso dell'interfaccia CLI (Configurazione dell'ambiente client per l'uso dell'interfaccia CLI per lo sviluppo del gateway API).

2. Aprire un prompt dei comandi ed eseguire oci api-gateway deployment create per creare la distribuzione:

   oci api-gateway deployment create --compartment-id <compartment-ocid> --display-name <api-name> --gateway-id <gateway-ocid> --path-prefix "/<deployment-path-prefix>" --specification file:///<filename>
   

   dove:

   • <compartment-ocid> è l'OCID del compartimento in cui creare la nuova distribuzione API.
   • <api-name> è il nome della nuova distribuzione API. Evitare di inserire informazioni riservate.
   • <gateway-ocid> è l'OCID del gateway esistente su cui distribuire l'API. Per informazioni sull'OCID del gateway API, vedere Elenco dei gateway API.

   • /<deployment-path-prefix> è un percorso in cui distribuire tutti gli instradamenti contenuti nella specifica di distribuzione API.

     Tenere presente che il prefisso del percorso di distribuzione specificato è il seguente:

     • deve essere preceduta da una barra ( / ) nel file JSON e può essere solo una barra singola
     • può contenere più barre in avanti (a condizione che non siano adiacenti), ma non deve terminare con una barra in avanti
     • può includere caratteri alfanumerici maiuscoli e minuscoli
     • può includere i caratteri speciali $ - _ . + ! * ' ( ) , % ; : @ & =
     • impossibile includere parametri e caratteri jolly

     Inoltre, se una distribuzione API ha una singola barra come prefisso del percorso di distribuzione, questa è l'unica distribuzione API consentita su un determinato gateway API. Non è possibile creare una distribuzione API con una singola barra come prefisso del percorso di distribuzione se esiste già un'altra distribuzione API nello stesso gateway API.

   • <filename> è la specifica di distribuzione API, che include un percorso, uno o più metodi e una definizione backend. Vedere Creazione di una specifica di distribuzione API.

   Ad esempio:

   oci api-gateway deployment create --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq --display-name "Marketing Deployment" --gateway-id ocid1.apigateway.oc1..aaaaaaaab______hga --path-prefix "/marketing" --specification file:///Users/jdoe/work/deployment.json

   La risposta al comando include quanto riportato di seguito.

   • OCID della distribuzione API.

   • Nome host sul quale è stata creata la distribuzione API, sotto forma di nome dominio nel formato <gateway-identifier>.apigateway.<region-identifier>.oci.customer-oci.com, dove:

     • <gateway-identifier> è la stringa di caratteri che identifica il gateway API. Ad esempio, lak...sjd (abbreviato per leggibilità).
     • <region-identifier> è l'identificativo dell'area in cui è stata creata la distribuzione API. Vedere Disponibilità per area.

     Ad esempio, lak...sjd.apigateway.us-phoenix-1.oci.customer-oci.com.

     Il nome host sarà il nome di dominio da utilizzare quando si richiama un'interfaccia API distribuita nel gateway API.

   • Stato del ciclo di vita (ad esempio, ACTIVE, FAILED).
   • ID della richiesta di lavoro per creare 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 create --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq --display-name "Marketing Deployment" --gateway-id ocid1.apigateway.oc1..aaaaaaaab______hga --path-prefix "/marketing" --specification file:///Users/jdoe/work/deployment.json --wait-for-state ACTIVE

   Tenere presente che non è possibile utilizzare la distribuzione API finché la richiesta di lavoro non la ha creata correttamente e la distribuzione API non è attiva.

3. (Facoltativo) Per visualizzare lo stato della distribuzione dell'API, immettere:

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

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

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

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

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

6. (Facoltativo) Se la richiesta di lavoro che sta creando 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>

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.

Per informazioni sull'uso dell'API e delle richieste di firma, consulta la documentazione dell'API REST e le credenziali di sicurezza. Per informazioni sugli SDK, vedere SDK e l'interfaccia CLI.

Utilizzare l'operazione CreateDeployment per creare una distribuzione API.