Inizia a utilizzare Cloud Endpoints per i gruppi di istanze gestite (MIG) con ESPv2


Questo tutorial mostra come configurare ed eseguire il deployment di un'API di esempio e di Extensible Service Proxy V2 (ESPv2) in container Docker predefiniti su Managed Instance Group (MIG) .

L'API REST del codice campione è descritta utilizzando la specifica OpenAPI. Il tutorial mostra anche come creare una chiave API e utilizzarla nelle richieste all'API.

Per una panoramica di Cloud Endpoints, consulta Informazioni su Endpoints e Architettura di Endpoints.

Obiettivi

Segui il seguente elenco di attività di alto livello durante il tutorial. Tutte le attività sono necessarie per inviare richieste all'API.

  1. Configura un progetto Google Cloud . Vedi Prima di iniziare.
  2. Scarica il codice campione. Consulta la sezione Recupero del codice di esempio.
  3. Configura il file openapi.yaml, utilizzato per configurare Endpoints. Consulta Configurare Endpoints.
  4. Esegui il deployment della configurazione di Endpoints per creare un servizio Endpoints. Consulta Eseguire il deployment della configurazione di Endpoints.
  5. Esegui il deployment dell'API e di ESPv2 sul backend del gruppo di istanze gestite (MIG). Consulta Eseguire il deployment del backend dell'API.
  6. Invia una richiesta all'API utilizzando un indirizzo IP. Consulta Invio di una richiesta utilizzando l'indirizzo IP.
  7. Configura un record DNS per l'API di esempio. Consulta Configurare DNS per Endpoints.
  8. Invia una richiesta all'API utilizzando il nome di dominio completo. Consulta Inviare una richiesta utilizzando l'FQDN.
  9. Monitora l'attività dell'API. Consulta Monitorare l'attività dell'API.
  10. Evita di incorrere in addebiti sul tuo account Google Cloud . Consulta Pulizia.

Costi

In questo documento utilizzi i seguenti componenti fatturabili di Google Cloud:

Per generare una stima dei costi in base all'utilizzo previsto, utilizza il Calcolatore prezzi. I nuovi Google Cloud utenti potrebbero avere diritto a una prova gratuita.

Al termine delle attività descritte in questo documento, puoi evitare la fatturazione continua eliminando le risorse che hai creato. Per ulteriori informazioni, consulta la sezione Pulizia.

Prima di iniziare

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  5. Make sure that billing is enabled for your Google Cloud project.

  6. Prendi nota dell'ID progetto perché ti servirà in seguito.
  7. Devi disporre di un'applicazione per inviare richieste all'API di esempio.

    • Utenti Linux e macOS: questo tutorial fornisce un esempio di utilizzo di curl, che in genere è preinstallato sul sistema operativo. Se non hai curl, puoi scaricarlo dalla curl pagina Release e download.
    • Utenti Windows: questo tutorial fornisce un esempio di utilizzo di Invoke-WebRequest, supportato in PowerShell 3.0 e versioni successive.
  8. Scarica Google Cloud CLI.
  9. Aggiorna gcloud CLI e installa i componenti di Endpoints.
    gcloud components update
  10. Assicurati che Google Cloud CLI (gcloud) sia autorizzato ad accedere ai tuoi dati e servizi su Google Cloud:
    gcloud auth login
    Nella nuova scheda del browser che si apre, seleziona un account.
  11. Imposta il progetto predefinito sul tuo ID progetto.
    gcloud config set project YOUR_PROJECT_ID

    Sostituisci YOUR_PROJECT_ID con l'ID progetto. Se hai altri progetti Google Cloud e vuoi utilizzarli con gcloud, consulta Gestire le configurazioni di gcloud CLI.

Al termine delle attività descritte in questo documento, puoi evitare la fatturazione continua eliminando le risorse che hai creato. Per ulteriori informazioni, consulta la sezione Pulizia.

Scarica il codice campione

Scarica il codice campione nella macchina locale.

Java

Per clonare o scaricare l'API di esempio:

  1. Clona il repository dell'app di esempio sulla tua macchina locale:
    git clone https://github.com/GoogleCloudPlatform/java-docs-samples

    In alternativa, scarica l'esempio come file ZIP ed estrailo.

  2. Passa alla directory che contiene il codice di esempio:
    cd java-docs-samples/endpoints/getting-started
Python

Per clonare o scaricare l'API di esempio:

  1. Clona il repository dell'app di esempio sulla tua macchina locale:
    git clone https://github.com/GoogleCloudPlatform/python-docs-samples

    In alternativa, scarica l'esempio come file ZIP ed estrailo.

  2. Passa alla directory che contiene il codice di esempio:
    cd python-docs-samples/endpoints/getting-started
Vai

Per clonare o scaricare l'API di esempio:

  1. Assicurati che la variabile di ambiente GOPATH sia impostata.
  2. Clona il repository dell'app di esempio sulla tua macchina locale:
    go get -d github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started
  3. Passa alla directory che contiene il codice di esempio:
    cd $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started
PHP

Per clonare o scaricare l'API di esempio:

  1. Clona il repository dell'app di esempio sulla tua macchina locale:
    git clone https://github.com/GoogleCloudPlatform/php-docs-samples

    In alternativa, scarica l'esempio come file ZIP ed estrailo.

  2. Passa alla directory che contiene il codice di esempio:
    cd php-docs-samples/endpoints/getting-started
Ruby

Per clonare o scaricare l'API di esempio:

  1. Clona il repository dell'app di esempio sulla tua macchina locale:
    git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples

    In alternativa, scarica l'esempio come file ZIP ed estrailo.

  2. Passa alla directory che contiene il codice di esempio:
    cd ruby-docs-samples/endpoints/getting-started
Node.js

Per clonare o scaricare l'API di esempio:

  1. Clona il repository dell'app di esempio sulla tua macchina locale:
    git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples

    In alternativa, scarica l'esempio come file ZIP ed estrailo.

  2. Passa alla directory che contiene il codice di esempio:
    cd nodejs-docs-samples/endpoints/getting-started

Configurazione di Endpoints

Il codice campione include il file di configurazione OpenAPI openapi.yaml, che si basa sulla specifica OpenAPI 2.0. Configura e esegui il deployment di openapi.yaml sulla tua macchina locale. Per configurare Endpoints:

  1. Nella directory codice campione, apri il file di configurazione openapi.yaml.

    Java
    swagger: "2.0"
    info:
      description: "A simple Google Cloud Endpoints API example."
      title: "Endpoints Example"
      version: "1.0.0"
    host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"
    Python
    swagger: "2.0"
    info:
      description: "A simple Google Cloud Endpoints API example."
      title: "Endpoints Example"
      version: "1.0.0"
    host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"
    Vai
    swagger: "2.0"
    info:
      description: "A simple Google Cloud Endpoints API example."
      title: "Endpoints Example"
      version: "1.0.0"
    host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"
    PHP
    swagger: "2.0"
    info:
      description: "A simple Google Cloud Endpoints API example."
      title: "Endpoints Example"
      version: "1.0.0"
    host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"
    Ruby
    swagger: "2.0"
    info:
      description: "A simple Google Cloud Endpoints API example."
      title: "Endpoints Example"
      version: "1.0.0"
    host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"
    Node.js
    swagger: "2.0"
    info:
      description: "A simple Google Cloud Endpoints API example."
      title: "Endpoints Example"
      version: "1.0.0"
    host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

    Tieni presente quanto segue:

    • L'esempio di configurazione mostra le righe vicino al campo host che devi modificare. Per eseguire il deployment del file openapi.yaml in Endpoints, è necessario il documento OpenAPI completo.
    • Il file di esempio openapi.yaml contiene una sezione per la configurazione dell'autenticazione non necessaria per questo tutorial. Non è necessario configurare le righe con YOUR-SERVICE-ACCOUNT-EMAIL e YOUR-CLIENT-ID.
    • OpenAPI è una specifica indipendente dal linguaggio. Per comodità, lo stesso file openapi.yaml è presente nell'esempio getting-started in ogni repository GitHub per ogni lingua.
  2. Nel campo host, sostituisci il testo con il nome del servizio Endpoints, che deve avere il seguente formato:
    host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"

    Sostituisci YOUR_PROJECT_ID con l'ID progetto Google Cloud . Ad esempio:

    host: "echo-api.endpoints.example-project-12345.cloud.goog"

Tieni presente che echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog è il nome del servizio Endpoints. Non è il nome di dominio completo (FQDN) che utilizzi per inviare richieste all'API.

Per informazioni sui campi nel documento OpenAPI richiesti da Endpoints, consulta Configurare Endpoints. Dopo aver completato tutti i passaggi di configurazione riportati di seguito per poter inviare richieste all'API di esempio utilizzando un indirizzo IP, consulta la sezione Configurazione del DNS degli endpoint per informazioni su come configurare echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog come FQDN.

esegui il deployment della configurazione di Endpoints

Per eseguire il deployment della configurazione di Endpoints, utilizza il comando gcloud endpoints services deploy. Questo comando utilizza Gestione servizi per creare un servizio gestito.

Per eseguire il deployment della configurazione di Endpoints:

  1. Assicurati di essere nella directory endpoints/getting-started.
  2. Carica la configurazione e crea un servizio gestito:
    gcloud endpoints services deploy openapi.yaml
    

Il comando gcloud chiama quindi l'API Service Management per creare un servizio gestito con il nome specificato nel campo host del file openapi.yaml. Service Management configura il servizio in base alle impostazioni nel file openapi.yaml. Quando apporti modifiche a openapi.yaml, devi eseguire nuovamente il deployment del file per aggiornare il servizio Endpoints.

Durante la creazione e la configurazione del servizio, Service Management visualizza informazioni nel terminale. Puoi ignorare tranquillamente gli avvisi relativi ai percorsi nel file openapi.yaml che non richiedono una chiave API. Al termine della configurazione del servizio, Service Management visualizza un messaggio con l'ID configurazione del servizio e il nome del servizio, simile al seguente:

Service Configuration [2017-02-13r0] uploaded for service [echo-api.endpoints.example-project-12345.cloud.goog]

Nell'esempio precedente, 2017-02-13r0 è l'ID configurazione del servizio e echo-api.endpoints.example-project-12345.cloud.goog è il servizio Endpoints. L'ID configurazione del servizio è costituito da un timbro di data seguito da un numero di revisione. Se esegui di nuovo il deployment del file openapi.yaml nello stesso giorno, il numero di revisione viene incrementato nell'ID configurazione del servizio. Puoi visualizzare la configurazione del servizio Endpoints nella pagina Endpoints > Servizi nella console Google Cloud .

Se viene visualizzato un messaggio di errore, consulta Risoluzione dei problemi di deployment della configurazione di Endpoints.

Verifica dei servizi richiesti

Come minimo, Endpoints ed ESP richiedono l'attivazione dei seguenti servizi Google:
Nome Titolo
servicemanagement.googleapis.com API Service Management
servicecontrol.googleapis.com API Service Control

Nella maggior parte dei casi, il comando gcloud endpoints services deploy attiva questi servizi obbligatori. Tuttavia, il comando gcloud viene completato correttamente, ma non attiva i servizi richiesti nelle seguenti circostanze:

  • Se hai utilizzato un'applicazione di terze parti come Terraform e non includi questi servizi.

  • Hai eseguito il deployment della configurazione di Endpoints in un progettoGoogle Cloud esistente in cui questi servizi sono stati disattivati esplicitamente.

Utilizza il seguente comando per verificare che i servizi richiesti siano abilitati:

gcloud services list

Se non vedi i servizi richiesti nell'elenco, attivali:

gcloud services enable servicemanagement.googleapis.com
gcloud services enable servicecontrol.googleapis.com

Abilita anche il servizio Endpoints:

gcloud services enable ENDPOINTS_SERVICE_NAME

Per determinare ENDPOINTS_SERVICE_NAME, puoi:

  • Dopo aver eseguito il deployment della configurazione di Endpoints, vai alla pagina Endpoints nella console Cloud. L'elenco dei possibili ENDPOINTS_SERVICE_NAME è riportato nella colonna Nome servizio.

  • Per OpenAPI, ENDPOINTS_SERVICE_NAME è il valore specificato nel campo host della specifica OpenAPI. Per gRPC, ENDPOINTS_SERVICE_NAME è il valore specificato nel campo name della configurazione degli endpoint gRPC.

Per ulteriori informazioni sui comandi gcloud, consulta Servizi gcloud.

Esegui il deployment del backend dell'API

Crea un modello di istanza

Crea un modello da utilizzare per creare un gruppo di istanze VM. Ogni istanza creata dal modello avvia un ESPv2 e un server applicazioni backend.

  1. Nella console Google Cloud , vai alla pagina Modelli di istanza.

    Vai a Modelli di istanza

  2. Fai clic su Crea modello istanza.

  3. In Nome, inserisci load-balancing-espv2-template.

  4. In Configurazione macchina, imposta Tipo di macchina su e2-micro.

  5. In Disco di avvio, imposta Immagine su Container Optimized OS stable version.

  6. In Firewall, seleziona Consenti traffico HTTP.

  7. Fai clic su Gestione, sicurezza, dischi, networking, single-tenancy per visualizzare le impostazioni avanzate.

  8. Fai clic sulla scheda Gestione. In Automazione, inserisci il seguente Script di avvio. Ricordati di aggiornare ENDPOINTS_SERVICE_NAME.

    sudo docker network create --driver bridge esp_net
    sudo docker run \
      --detach \
      --name=echo \
      --net=esp_net \
      gcr.io/google-samples/echo-python:1.0
    sudo docker run \
      --detach \
      --name=esp \
      --publish=80:9000 \
      --net=esp_net \
      gcr.io/endpoints-release/endpoints-runtime:2 \
      --service=ENDPOINTS_SERVICE_NAME \
      --rollout_strategy=managed \
      --listener_port=9000 \
      --healthz=/healthz \
      --backend=echo:8080
    

    Lo script recupera, installa e avvia il server di applicazioni echo e il server proxy ESPv2 all'avvio dell'istanza.

  9. Fai clic su Crea.

Attendi il completamento della creazione del modello prima di continuare.

Crea un gruppo di istanze gestite regionale

Per eseguire l'applicazione, utilizza il modello di istanza per creare un gruppo di istanze gestite regionale:

  1. Nella console Google Cloud , vai alla pagina Gruppi di istanze.

    Vai a Gruppi di istanze

  2. Fai clic su Crea gruppo di istanze.

  3. In Nome, inserisci load-balancing-espv2-group.

  4. In Località, seleziona Più zone.

  5. In Regione, seleziona us-central1.

  6. Fai clic sul menu a discesa Configura zone per visualizzare Zone. Seleziona le seguenti zone:

    • us-central1-b
    • us-central1-c
    • us-central1-f
  7. In Modello di istanza, seleziona load-balancing-espv2-template.

  8. In Scalabilità automatica, seleziona Non scalare automaticamente.

  9. Imposta Numero di istanze su 3.

  10. In Ridistribuzione delle istanze, seleziona On.

  11. In Riparazione automatica e Controllo di integrità, seleziona Nessun controllo di integrità.

  12. Fai clic su Crea. Verrà visualizzata nuovamente la pagina Gruppi di istanze.

Crea un bilanciatore del carico

Questa sezione illustra i passaggi necessari per creare un bilanciatore del carico globale che indirizzi il traffico HTTP al gruppo di istanze.

Questo bilanciatore del carico utilizza un frontend per ricevere il traffico in entrata e un backend per distribuirlo alle istanze integre. Poiché il bilanciatore del carico è costituito da più componenti, questa attività è suddivisa in più parti:

  • Configurazione backend
  • Configurazione frontend
  • Esamina e finalizza

Completa tutti i passaggi per creare il bilanciatore del carico.

  1. Nella console Google Cloud , vai alla pagina Crea un bilanciatore del carico.

    Vai a Crea un bilanciatore del carico

  2. Nella sezione Bilanciatore del carico delle applicazioni (HTTP/S), fai clic su Avvia configurazione.

  3. In Per internet o solo interno, seleziona Da internet alle mie VM. Poi fai clic su Continua.

  4. In Nome del bilanciatore del carico, inserisci espv2-load-balancer.

Configurazione backend

  1. Nel riquadro sinistro della pagina Crea bilanciatore del carico delle applicazioni esterno globale, fai clic su Configurazione del backend.
  2. Fai clic su Crea o seleziona servizi di backend e bucket di backend per aprire un menu a discesa. Fai clic su Servizi di backend, quindi su Crea un servizio di backend.
  3. Nella nuova finestra, inserisci espv2-backend in Nome dell'applicazione di backend.
  4. Imposta Gruppo di istanze su load-balancing-espv2-group.
  5. Imposta Numeri di porta su 80. In questo modo consenti il traffico HTTP tra il bilanciatore del carico e il gruppo di istanze.
  6. In Modalità di bilanciamento, seleziona Utilizzo.
  7. Fai clic su Fine per creare il backend.
  8. Crea il controllo di integrità per il backend del bilanciatore del carico:

    1. In Controllo di integrità, seleziona Crea un controllo di integrità (o Crea un altro controllo di integrità) dal menu a discesa. Si apre una nuova finestra.
    2. Nella nuova finestra, in Nome, inserisci espv2-load-balancer-check.
    3. Imposta Protocollo su HTTP.
    4. In Porta, inserisci 80.
    5. Per questo tutorial, imposta Percorso richiesta su /healthz, che è un percorso a cui ESPv2 è configurato per rispondere.
    6. Imposta i seguenti criteri di integrità:

      1. Imposta Intervallo di controllo su 3 secondi. Questo definisce il tempo dall'inizio di un probe all'inizio del successivo.
      2. Imposta Timeout su 3 secondi. Questo valore definisce il tempo che Google Cloud attende una risposta a una sonda. Il valore deve essere minore o uguale all'intervallo di controllo.
      3. Imposta Soglia di stato integro su 2 operazioni riuscite consecutive. Questo definisce il numero di sondaggi sequenziali che devono essere riusciti affinché l'istanza sia considerata sana.
      4. Imposta Soglia non corretta su 2errori consecutivi. Questo definisce il numero di probe sequenziali che devono non riuscire affinché l'istanza sia considerata non integra.
    7. Fai clic su Salva e continua per creare il controllo di integrità.

  9. Fai clic su Crea per creare il servizio di backend.

Configurazione frontend

  1. Nel riquadro a sinistra della pagina Crea bilanciatore del carico delle applicazioni esterno globale, fai clic su Configurazione frontend.
  2. Nella pagina Configurazione frontend, in Nome, inserisci espv2-ipv4-frontend.
  3. Imposta Protocollo su HTTP.
  4. Imposta Porta su 80.
  5. Fai clic su Fine per creare il frontend.

Esamina e finalizza

  1. Verifica le impostazioni di bilanciamento del carico prima di creare il bilanciatore del carico:

    1. Nel riquadro a sinistra della pagina Crea bilanciatore del carico delle applicazioni esterno globale, fai clic su Esamina e completa.
    2. Nella pagina Rivedi e finalizza, verifica le seguenti impostazioni di Backend:

      • Il servizio di backend è espv2-backend.
      • Il protocollo endpoint è HTTP.
      • Il controllo di integrità è espv2-load-balancer-check.
      • Il gruppo di istanze è load-balancing-espv2-group.
    3. Nella stessa pagina, verifica che Frontend utilizzi un indirizzo IP con Protocollo HTTP.

  2. Nel riquadro a sinistra della pagina Crea bilanciatore del carico delle applicazioni esterno globale, fai clic su Crea per completare la creazione del bilanciatore del carico.

    Potresti dover attendere qualche minuto per il completamento della creazione del bilanciatore del carico.

  3. Una volta creato il bilanciatore del carico, individua l'indirizzo IP nella pagina Bilanciatore del carico.

    Vai a Bilanciatore del carico

Invio di una richiesta utilizzando un indirizzo IP

Dopo aver eseguito l'API di esempio e ESPv2 sul backend di cui è stato eseguito il deployment, puoi inviare richieste all'API dalla tua macchina locale.

Crea una chiave API e imposta una variabile di ambiente

Il codice campione richiede una chiave API. Per semplificare la richiesta, imposta una variabile di ambiente per la chiave API.

  1. Nello stesso progetto Google Cloud che hai utilizzato per la tua API, crea una chiave API nella pagina delle credenziali API. Se vuoi creare una chiave API in un altro progetto Google Cloud , consulta Abilitare un'API nel progetto Google Cloud .

    Vai alla pagina Credenziali

  2. Fai clic su Crea credenziali e poi seleziona Chiave API.
  3. Copia la chiave negli appunti.
  4. Fai clic su Chiudi.
  5. Sul computer locale, incolla la chiave API per assegnarla a una variabile di ambiente:
    • In Linux o macOS: export ENDPOINTS_KEY=AIza...
    • In Windows PowerShell: $Env:ENDPOINTS_KEY="AIza..."

Invia la richiesta

Linux o Mac OS

Utilizza curl per inviare una richiesta HTTP utilizzando la variabile di ambiente ENDPOINTS_KEY impostata in precedenza. Sostituisci IP_ADDRESS con l'indirizzo IP esterno della tua istanza.

curl --request POST \
   --header "content-type:application/json" \
   --data '{"message":"hello world"}' \
   "http://IP_ADDRESS:80/echo?key=${ENDPOINTS_KEY}"

Nel curl precedente:

  • L'opzione --data specifica i dati da pubblicare nell'API.
  • L'opzione --header specifica che i dati sono in formato JSON.

PowerShell

Utilizza Invoke-WebRequest per inviare una richiesta HTTP utilizzando la variabile di ambiente ENDPOINTS_KEY impostata in precedenza. Sostituisci IP_ADDRESS con l'indirizzo IP esterno della console.

(Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' `
    -Headers @{"content-type"="application/json"} `
    -URI "http://IP_ADDRESS:80/echo?key=$Env:ENDPOINTS_KEY").Content

Nell'esempio precedente, le prime due righe terminano con un backtick. Quando incolli l'esempio in PowerShell, assicurati che non ci sia uno spazio dopo i backtick. Per informazioni sulle opzioni utilizzate nella richiesta di esempio, consulta Invoke-WebRequest nella documentazione di Microsoft.

App di terze parti

Puoi utilizzare un'applicazione di terze parti come l'estensione del browser Chrome Postman per inviare la richiesta:

  • Seleziona POST come verbo HTTP.
  • Per l'intestazione, seleziona la chiave content-type e il valore application/json.
  • Per il corpo, inserisci quanto segue:
    {"message":"hello world"}
  • Nell'URL, utilizza la chiave API effettiva anziché la variabile di ambiente. Ad esempio:
    http://192.0.2.0:80/echo?key=AIza...

L'API restituisce il messaggio che invii e risponde con quanto segue:

{
  "message": "hello world"
}

Se non hai ricevuto una risposta positiva, consulta la sezione Risoluzione dei problemi relativi alle risposte.

Hai eseguito il deployment e il test di un'API in Endpoints.

Configurazione del DNS per gli endpoint

Poiché il nome del servizio Endpoints per l'API si trova nel dominio .endpoints.YOUR_PROJECT_ID.cloud.goog, puoi usarlo come nome di dominio completo (FQDN) apportando una piccola modifica alla configurazione nel file openapi.yaml. In questo modo, puoi inviare richieste all'API di esempio utilizzando echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog instead of the IP address.

Per configurare il DNS di Endpoints:

  1. Apri il file di configurazione OpenAPI openapi.yaml e aggiungi la proprietà x-google-endpoints al livello superiore del file (senza rientrare o nidificare) come mostrato nello snippet seguente:
    host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
    x-google-endpoints:
    - name: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
      target: "IP_ADDRESS"
  2. Nella proprietà name, sostituisci YOUR_PROJECT_ID con l'ID del tuo progetto.
  3. Nella proprietà target, sostituisci IP_ADDRESS con l'indirizzo IP utilizzato quando hai inviato una richiesta all'API di esempio.
  4. Esegui il deployment del file di configurazione OpenAPI aggiornato in Service Management:
    gcloud endpoints services deploy openapi.yaml
    

Ad esempio, supponiamo che nel file openapi.yaml sia configurato quanto segue:

host: "echo-api.endpoints.example-project-12345.cloud.goog"
x-google-endpoints:
- name: "echo-api.endpoints.example-project-12345.cloud.goog"
  target: "192.0.2.1"

Quando esegui il deployment del file openapi.yaml utilizzando il comando gcloud precedente, Service Management crea un record A DNS, echo-api.endpoints.my-project-id.cloud.goog, che risolve nell'indirizzo IP di destinazione 192.0.2.1. Potrebbero essere necessari alcuni minuti prima che la nuova configurazione DNS venga propagata.

Configurazione di SSL

Per ulteriori dettagli su come configurare DNS e SSL, consulta Attivare SSL per gli endpoint.

Invio di una richiesta utilizzando l'FQDN

Ora che hai configurato il record DNS per l'API di esempio, invia una richiesta utilizzando il FQDN (sostitui YOUR_PROJECT_ID con il tuo ID progetto) e la variabile di ambiente ENDPOINTS_KEY impostata in precedenza:
  • In Linux o macOS:
    curl --request POST \
        --header "content-type:application/json" \
        --data '{"message":"hello world"}' \
        "http://echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog:80/echo?key=${ENDPOINTS_KEY}"
  • In Windows PowerShell:
    (Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' -Headers @{"content-type"="application/json"} -URI "http://echo-api.endpoints.[YOUR_PROJECT_ID].cloud.goog:80/echo?key=$Env:ENDPOINTS_KEY").Content

monitora l'attività dell'API

Per monitorare l'attività dell'API:

  1. Esamina i grafici delle attività della tua API nella pagina Endpoints > Servizi.

    Vai alla pagina Servizi endpoint


    La visualizzazione dei dati relativi alla richiesta nei grafici può richiedere alcuni minuti.
  2. Esamina i log delle richieste per la tua API nella pagina Esplora log.

    Vai alla pagina Esplora log

Creazione di un portale per gli sviluppatori per l'API

Puoi utilizzare il portale Cloud Endpoints per creare un portale per gli sviluppatori, un sito web che puoi utilizzare per interagire con l'API di esempio. Per saperne di più, consulta la panoramica del portale Cloud Endpoints.

Esegui la pulizia

Per evitare che al tuo account Google Cloud vengano addebitati costi relativi alle risorse utilizzate in questo tutorial, elimina il progetto che contiene le risorse oppure mantieni il progetto ed elimina le singole risorse.

  1. Assicurati che gcloud CLI (gcloud) sia autorizzato ad accedere ai tuoi dati e servizi su Google Cloud:

    gcloud auth login
    
  2. Inserisci quanto segue per visualizzare gli ID progetto per i tuoi progetti Google Cloud:

    gcloud projects list
    
  3. Utilizzando l'ID progetto applicabile del passaggio precedente, imposta il progettoGoogle Cloud predefinito su quello in cui si trova la tua applicazione:

    gcloud config set project [YOUR_PROJECT_ID]
    
  4. Ottieni il nome di tutti i servizi gestiti nel tuo progetto Google Cloud :

    gcloud endpoints services list
    
  5. Elimina il servizio da Gestione servizi. Sostituisci SERVICE_NAME con il nome del servizio che vuoi rimuovere.

    gcloud endpoints services delete SERVICE_NAME
    

    L'esecuzione di gcloud endpoints services delete non elimina immediatamente il servizio gestito. Service Management disattiva il servizio gestito per 30 giorni, il che ti consente di ripristinarlo, se necessario. Dopo 30 giorni, Service Management elimina definitivamente il servizio gestito.

  6. Vai alla pagina Bilanciatore del carico.

    Vai a Bilanciatore del carico

    Elimina il bilanciatore del carico espv2-load-balancer con il servizio di backend espv2-backend e il controllo di integrità espv2-load-balancer-check.

  7. Vai alla pagina Gruppi di istanze.

    Vai a Gruppi di istanze

    Elimina load-balancing-espv2-group

  8. Vai alla pagina Modello di istanza.

    Vai a Modelli di istanza

    Elimina load-balancing-espv2-template.

Passaggi successivi